zulip/requirements
rht a3a71487b0 CI: Add Codespell linter.
This tool helps catch common typos in code and documentation, which is
particularly useful for our many contributors who are not native
English speakers.

The config is based on the codespell that I ran in
https://github.com/zulip/zulip/pull/18535.
2021-10-27 16:49:30 -07:00
..
README.md docs: Fix list item indentation mistakes. 2021-08-20 23:14:37 -07:00
common.in markdown: CSS-escape preview links. 2021-10-26 18:17:23 -07:00
dev.in CI: Add Codespell linter. 2021-10-27 16:49:30 -07:00
dev.txt CI: Add Codespell linter. 2021-10-27 16:49:30 -07:00
docs.in requirements: Upgrade Python requirements. 2021-09-17 17:05:18 -07:00
docs.txt requirements: Upgrade Python requirements. 2021-10-16 12:25:43 -07:00
mypy.in python: Upgrade SQLAlchemy from 1.3.24 to 1.4.23. 2021-08-31 06:47:39 -07:00
mypy.txt requirements: Upgrade Python requirements. 2021-10-16 12:25:43 -07:00
pip.in requirements: Upgrade Python requirements. 2021-05-07 22:42:39 -07:00
pip.txt requirements: Upgrade Python requirements. 2021-10-16 12:25:43 -07:00
prod.in requirements: Remove unnecessary version bounds from *.in. 2019-09-23 13:23:58 -07:00
prod.txt markdown: CSS-escape preview links. 2021-10-26 18:17:23 -07:00

README.md

The dependency graph of the requirements is as follows:

dev +-> prod +-> common
+
|
v
mypy,docs,pip

Of the files, only dev, prod, and mypy have been used in the install scripts directly. The rest are implicit dependencies.

Steps to update a lock file, e.g. to update ipython from 5.3.0 to latest version:

  1. Remove entry for ipython==5.3.0 in dev.txt.
  2. Run ./tools/update-locked-requirements, which will generate new entries, pinned to the latest version.
  3. Increase PROVISION_VERSION in version.py.
  4. Run ./tools/provision to install the new deps and test them.
  5. Commit your changes.