zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-08-20 00:14:16 +02:00
Code Issues Projects Releases Packages Wiki Activity
manage.get.gov/docs/operations/runbooks/update_python_dependencies.md
Seamus Johnston ba7e97ba18
Begin using requirements.txt
2023-03-31 09:21:02 -05:00

1.1 KiB
Raw Blame History

HOWTO Update Python Dependencies

========================

  1. Check the Pipfile for pinned dependencies and manually adjust the version numbers

  2. Run

     cd src
 docker-compose run app bash -c "pipenv lock && pipenv requirements > requirements.txt"

    This will generate a new Pipfile.lock and create a new requirements.txt. It will not install anything.

    It is necessary to use bash -c because run pipenv requirements will not recognize that it is running non-interactively and will include garbage formatting characters.

    The requirements.txt is used by Cloud.gov. It is needed to work around a bug in the CloudFoundry buildpack version of Pipenv that breaks on installing from a git repository.

  3. (optional) Run docker-compose stop and docker-compose build to build a new image for local development with the updated dependencies.

    The reason for de-coupling the build and lock steps is to increase consistency between builds--a run of build will always get exactly the dependencies listed in Pipfile.lock, nothing more, nothing less.