Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/requirements/README.md

21 lines
613 B
Markdown
Raw Normal View History

Lock the recursive requirements in common.txt via pip-compile. The commit is composed of: (1) distill out top-level dependencies in common.txt, (2) add -e flag to the vcs-based packages because pip-compile can't do without, (3) pip-compile/generate the locked files then remove the -e flags from the lockfile, (4) pin pathlib2 to dev.txt because it turns out it is a direct requirement of documentation_crawler, (5) document the structure and add an automation script (6) remove cryptography==1.9 from requirements/scrapy.txt since cryptography is automatically added from pyopenssl (7) add sed command to remove future/futures from the generated lock file in python3 (this should have been automatically handled by pip-compile, so pending for the feature from pip-compile) Tweaked by tabbott to update PROVISION_VERSION and add a missing `first` dependency.
2017-05-12 02:30:38 +02:00
The dependency graph of the requirements is as follows:
```
update-locked-requirements: Generate prod locks from dev locks. This guarantees that we don’t accidentally upgrade one without the other, which could happen for example due to different third-party version constraints between the two. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-18 01:45:40 +02:00
dev +-> prod +-> common
+
|
Lock the recursive requirements in common.txt via pip-compile. The commit is composed of: (1) distill out top-level dependencies in common.txt, (2) add -e flag to the vcs-based packages because pip-compile can't do without, (3) pip-compile/generate the locked files then remove the -e flags from the lockfile, (4) pin pathlib2 to dev.txt because it turns out it is a direct requirement of documentation_crawler, (5) document the structure and add an automation script (6) remove cryptography==1.9 from requirements/scrapy.txt since cryptography is automatically added from pyopenssl (7) add sed command to remove future/futures from the generated lock file in python3 (this should have been automatically handled by pip-compile, so pending for the feature from pip-compile) Tweaked by tabbott to update PROVISION_VERSION and add a missing `first` dependency.
2017-05-12 02:30:38 +02:00
v
update-locked-requirements: Generate prod locks from dev locks. This guarantees that we don’t accidentally upgrade one without the other, which could happen for example due to different third-party version constraints between the two. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-18 01:45:40 +02:00
mypy,docs,pip
Lock the recursive requirements in common.txt via pip-compile. The commit is composed of: (1) distill out top-level dependencies in common.txt, (2) add -e flag to the vcs-based packages because pip-compile can't do without, (3) pip-compile/generate the locked files then remove the -e flags from the lockfile, (4) pin pathlib2 to dev.txt because it turns out it is a direct requirement of documentation_crawler, (5) document the structure and add an automation script (6) remove cryptography==1.9 from requirements/scrapy.txt since cryptography is automatically added from pyopenssl (7) add sed command to remove future/futures from the generated lock file in python3 (this should have been automatically handled by pip-compile, so pending for the feature from pip-compile) Tweaked by tabbott to update PROVISION_VERSION and add a missing `first` dependency.
2017-05-12 02:30:38 +02:00
```
tools: Remove old python 3 compatibility checker. Now that we've migrated over to Python 3, this tool is no longer required. Fixes #6217.
2017-08-22 23:18:23 +02:00
Of the files, only dev, prod, and mypy have been used in the install
requirements: Remove Python 2-specific files.
2017-08-09 09:45:00 +02:00
scripts directly. The rest are implicit dependencies.
Lock the recursive requirements in common.txt via pip-compile. The commit is composed of: (1) distill out top-level dependencies in common.txt, (2) add -e flag to the vcs-based packages because pip-compile can't do without, (3) pip-compile/generate the locked files then remove the -e flags from the lockfile, (4) pin pathlib2 to dev.txt because it turns out it is a direct requirement of documentation_crawler, (5) document the structure and add an automation script (6) remove cryptography==1.9 from requirements/scrapy.txt since cryptography is automatically added from pyopenssl (7) add sed command to remove future/futures from the generated lock file in python3 (this should have been automatically handled by pip-compile, so pending for the feature from pip-compile) Tweaked by tabbott to update PROVISION_VERSION and add a missing `first` dependency.
2017-05-12 02:30:38 +02:00
docs: Refresh docs on updating python requirements. Those docs were outdated and no longer represantative of how things work. upgrade-python-dependencies and unupgradable.json are no longer a thing, so the entire paragraph about them should be removed. Then the requirements/README.md file is refreshed a bit to be more accurate.
2020-03-18 13:51:22 +01:00
Steps to update a lock file, e.g. to update ipython from 5.3.0 to latest version:
docs: Fix list item indentation mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 23:37:38 +02:00
requirements: Update example to match the line above.
2021-03-03 22:40:57 +01:00
0. Remove entry for `ipython==5.3.0` in dev.txt.
docs: Refresh docs on updating python requirements. Those docs were outdated and no longer represantative of how things work. upgrade-python-dependencies and unupgradable.json are no longer a thing, so the entire paragraph about them should be removed. Then the requirements/README.md file is refreshed a bit to be more accurate.
2020-03-18 13:51:22 +01:00
1. Run `./tools/update-locked-requirements`, which will generate new entries, pinned to the latest version.
requirements: Add documentation on regenerating lockfiles.
2017-08-30 00:45:33 +02:00
2. Increase `PROVISION_VERSION` in `version.py`.
requirements: Improve README's format.
2018-05-26 00:30:38 +02:00
3. Run `./tools/provision` to install the new deps and test them.
requirements: Add documentation on regenerating lockfiles.
2017-08-30 00:45:33 +02:00
4. Commit your changes.