Skip to content

Commit 3e51ba4

Browse files
authored
Update documentation on dependency installation (encode#8566)
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 250479d 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.
1 parent 73f4835 commit 3e51ba4

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/community/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ To run the tests, clone the repository, and then:
8080
# Setup the virtual environment
8181
python3 -m venv env
8282
source env/bin/activate
83-
pip install django
83+
pip install -e .
8484
pip install -r requirements.txt
8585

8686
# Run the tests

requirements.txt

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# The base set of requirements for REST framework is actually
2-
# just Django, but for the purposes of development and testing
3-
# there are a number of packages that are useful to install.
2+
# just Django and pytz, but for the purposes of development
3+
# and testing there are a number of packages that are useful
4+
# to install.
45

56
# Laying these out as separate requirements files, allows us to
67
# only included the relevant sets when running tox, and ensures

0 commit comments

Comments
 (0)