encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-23 10:03:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation on dependency installation (#8566)

Browse Source 
We depend on pytz, but until late last year we got it implicitly through
depending on Django. Since their release 4.0, however, they no longer
depend on pytz; commit 250479dc3 added the dependency directly to our
metadata in setup.py, but the documentation about dependencies (most
importantly, the instructions for new contributors) was left untouched.

This commit updates the new contributor instructions to suggest an
"editable installation" of the project at the step that previously had
users manually install Django. In this mode, pip fetches and installs
the project dependencies automatically (so in the unlikely event we grow
another dependency, that doc doesn't need to be changed again) and makes
the project available to the virtualenv's python as a normal package,
but doesn't require reinstallation for mundane edits.
This commit is contained in:
Allie 2022-09-27 05:54:52 -07:00 committed by GitHub
parent 73f4835a53
commit 3e51ba4d51
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/community/contributing.md
View File

@ -80,7 +80,7 @@ To run the tests, clone the repository, and then:
# Setup the virtual environment # Setup the virtual environment
python3 -m venv env python3 -m venv env
source env/bin/activate source env/bin/activate
pip install django pip install -e .
pip install -r requirements.txt pip install -r requirements.txt
# Run the tests # Run the tests

5
requirements.txt
View File

@ -1,6 +1,7 @@
# The base set of requirements for REST framework is actually # The base set of requirements for REST framework is actually
# just Django, but for the purposes of development and testing # just Django and pytz, but for the purposes of development
# there are a number of packages that are useful to install. # and testing there are a number of packages that are useful
# to install.
# Laying these out as separate requirements files, allows us to # Laying these out as separate requirements files, allows us to
# only included the relevant sets when running tox, and ensures # only included the relevant sets when running tox, and ensures