Skip to content

Latest commit

 

History

History
 
 

{{cookiecutter.project_slug}}

{{ cookiecutter.project_name }}

{{ cookiecutter.project_short_description }}

Install

  1. Create virtual environment and activate:

    python -m venv .venv && source .venv/bin/activate

  2. Install package

    pip install -e . -r requirements.txt

    Or with optional dev dependencies:

    pip install -e ".[dev]" -r requirements.txt -r requirements_dev.txt

Developer Notes

Manage Dependencies

Dependencies are specified in pyproject.toml and managed with pip-tools.

  1. Install pip-tools (globally with pipx or in local virtual environment with pip)

  2. Generate lock files:

    pip-compile --output-file=requirements.txt pyproject.toml --quiet && pip-compile --extra=dev --output-file=requirements_dev.txt pyproject.toml --quiet

To upgrade a dependency, pass the --upgrade-package flag along with the name of the package, or to upgrade all packages, pass the --upgrade flag to the command.

More information at: https://github.com/jazzband/pip-tools/