Skip to content

Commit

Permalink
Add dependency management docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jkrzy committed Sep 28, 2018
1 parent 9424b63 commit 228b36b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
22 changes: 22 additions & 0 deletions docs/dependency-management.md
Original file line number Diff line number Diff line change
@@ -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/

0 comments on commit 228b36b

Please sign in to comment.