# Actes princiers -- refactoring datascience

## Getting started

- Install the virtual environment : `python3 -m venv .venv`
- Enable the virtual environment : `source .venv/bin/activate`
- Install the packages and libraries `pip install -r src/requirements.txt`

## Developper's rules and guidelines

Declare any dependencies in `src/requirements.txt` for `pip` installation.

To install them, run: `pip install -r src/requirements.txt`

## Project dependencies

To generate or update the dependency requirements for your project:

```
kedro build-reqs
```

This will `pip-compile` the contents of `src/requirements.txt` into a new file `src/requirements.lock`. You can see the output of the resolution by opening `src/requirements.lock`.

After this, if you'd like to update your project requirements, please update `src/requirements.txt` and re-run `kedro build-reqs`.

[Further information about project dependencies](https://kedro.readthedocs.io/en/stable/kedro_project_setup/dependencies.html#project-specific-dependencies)


Project Name
============

human readable name : `Actes Princiers`

The project name 'Actes Princiers' has been applied to:

- The project title in `datascience/actes-princiers/README.md` 
- The folder created for your project in `datascience/actes-princiers` 
- The project's python package in `datascience/actes-princiers/src/actes_princiers`

A best-practice setup includes initialising git and creating a virtual environment before running 'pip install -r src/requirements.txt'