You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

42 lines
1.5 KiB
Markdown

3 years ago
# Actes princiers -- refactoring datascience
3 years ago
3 years ago
## Getting started
3 years ago
3 years ago
- 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`
3 years ago
3 years ago
## Developper's rules and guidelines
3 years ago
3 years ago
Declare any dependencies in `src/requirements.txt` for `pip` installation.
3 years ago
3 years ago
To install them, run: `pip install -r src/requirements.txt`
3 years ago
3 years ago
## Project dependencies
3 years ago
3 years ago
To generate or update the dependency requirements for your project:
3 years ago
```
3 years ago
kedro build-reqs
3 years ago
```
3 years ago
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`.
3 years ago
3 years ago
After this, if you'd like to update your project requirements, please update `src/requirements.txt` and re-run `kedro build-reqs`.
3 years ago
3 years ago
[Further information about project dependencies](https://kedro.readthedocs.io/en/stable/kedro_project_setup/dependencies.html#project-specific-dependencies)
3 years ago
3 years ago
Project Name
============
3 years ago
3 years ago
human readable name : `Actes Princiers`
3 years ago
3 years ago
The project name 'Actes Princiers' has been applied to:
3 years ago
3 years ago
- 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`
3 years ago
3 years ago
A best-practice setup includes initialising git and creating a virtual environment before running 'pip install -r src/requirements.txt'