To replicate environment in local:
- Clone the repo
- The project uses python 3.7.1 or higher.
- For package and environment management, we use poetry:
- Install poetry from here
- Run
poetry install
to install environment and packages inpyproject.toml
- Run
poetry shell
to activate environment. (exit
for exit the env) - To add/remove a package, run
poetry add/remove MY_PACKAGE
- (Really Optional) We use pre-commit for linting, code-formatting right before git-commits:
- Before every commit, this will make a formatting edits to .py files (sometimes others too)
- It causes issues when files are both in staging and un-staged mode. Recommend staging all files before running pre-commit. Or just don't install it.
- Run
poetry run pre-commit install
to activate it
- Edit and commit as usual.