Skip to content

Commit

Permalink
Update python-truenas-requirements doc
Browse files Browse the repository at this point in the history
  • Loading branch information
themylogin committed Jun 6, 2024
1 parent 821f8b5 commit f08c209
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/source/os/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,18 @@ Adding a new third-party python module or upgrading an existing python module
#. Ensure that the resulting diff is a small as possible. Use `constraints.txt` to pin down some indirect dependencies
to the versions shipped with Debian.

Upgrading all third-party python modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Run `requirements-update.py` script to automatically update all items from `requirements.txt` to their latest versions.

Removing unused python modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Run `requirements-remove-unused.py` script **on the most recent TrueNAS build** to automatically remove
`requirements.txt` entries that are were not used by that most recent build.

This should be done when some of the python dependencies for TrueNAS components (middleware, CLI, etc.) were removed,
or when apt mirrors were updated (providing official newer versions of the python packages we were previously building
ourselves).

0 comments on commit f08c209

Please sign in to comment.