diff --git a/docs/README.md b/docs/README.md index ba11637..81d6096 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,6 +16,7 @@ Development and deploying - [Email configuration for new instances](email.md) - [Change Tracking & Data Lineage](history.md) - [Legacy Data Migration](data-migration.md) +- [Dependency Management](dependency-management.md) --- USKPA website administration - [Administering users and roles](administration.md) diff --git a/docs/dependency-management.md b/docs/dependency-management.md new file mode 100644 index 0000000..fe826c2 --- /dev/null +++ b/docs/dependency-management.md @@ -0,0 +1,22 @@ +[:arrow_left: Back to USKPA +Documentation](../docs) + +## Python + +The USKPA site uses [Pipenv] to manage development and production dependencies. +In both development and continuous integration, the Python environment is +established with `pipenv install --dev`. + +To accommodate third-party tools that do not yet support [Pipenv], [Pipenv] generates a `requirements.txt` file (containing +only production dependencies) and includes it in the repository. + +You can update development and production dependencies locally with the following: + +```sh +pipenv update --dev +pipenv lock --requirements > requirements.txt +``` + +This will generate updated `Pipfile`, `Pipfile.lock`, and `requirements.txt` files which must be committed to the git repository. + +[Pipenv]: https://docs.pipenv.org/