Skip to content

Commit dca25e1

Browse files
slivercn2ygk
authored andcommitted
Split requirements files up following DRF example (#720)
Fixes #712 Fixes #635 This way not all dependency need to be installed for the different testing steps.
1 parent 7655f02 commit dca25e1

13 files changed

+61
-31
lines changed

.pyup.yml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
search: False
22
requirements:
3-
- requirements-development.txt:
3+
- requirements/requirements-codestyle.txt:
4+
update: all
5+
pin: True
6+
- requirements/requirements-documentation.txt:
7+
update: all
8+
pin: True
9+
- requirements/requirements-optionals.txt:
10+
update: all
11+
pin: True
12+
- requirements/requirements-packaging.txt:
13+
update: all
14+
pin: True
15+
- requirements/requirements-testing.txt:
416
update: all
517
pin: True

.travis.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ matrix:
1515

1616
include:
1717
- python: 3.6
18-
env: TOXENV=flake8
18+
env: TOXENV=lint
19+
- python: 3.6
20+
env: TOXENV=docs
1921

2022
- python: 3.5
2123
env: TOXENV=py35-django111-drf310

README.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,7 @@ installed and activated:
128128

129129
$ git clone https://github.com/django-json-api/django-rest-framework-json-api.git
130130
$ cd django-rest-framework-json-api
131-
$ pip install -r example/requirements.txt
132-
$ pip install -e .
131+
$ pip install -U -e . -r requirements.txt
133132
$ django-admin migrate --settings=example.settings
134133
$ django-admin loaddata drf_example --settings=example.settings
135134
$ django-admin runserver --settings=example.settings
@@ -145,7 +144,7 @@ installed and activated:
145144

146145
::
147146

148-
$ pip install -Ur requirements-development.txt
147+
$ pip install -Ur requirements.txt
149148
$ flake8
150149
$ pytest
151150

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
django.setup()
3232

3333
# Auto-generate API documentation.
34-
main(['-o', '_build/apidoc', '-f', '-e', '-T', '-M', '../rest_framework_json_api'])
34+
main(['-o', 'apidoc', '-f', '-e', '-T', '-M', '../rest_framework_json_api'])
3535

3636
# -- General configuration ------------------------------------------------
3737

docs/getting-started.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,7 @@ From Source
7777
cd django-rest-framework-json-api
7878
python3 -m venv env
7979
source env/bin/activate
80-
pip install -r example/requirements.txt
81-
pip install -e .
80+
pip install -U -e . r requirements.txt
8281
django-admin migrate --settings=example.settings
8382
django-admin loaddata drf_example --settings=example.settings
8483
django-admin runserver --settings=example.settings

requirements-development.txt

Lines changed: 0 additions & 16 deletions
This file was deleted.

requirements.txt

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,13 @@
1-
1+
# The base set of requirements for Django REST framework JSON API is actually
2+
# fairly small, but for the purposes of development and testing
3+
# there are a number of packages that are useful to install.
4+
5+
# Laying these out as separate requirements files, allows us to
6+
# only included the relevant sets when running tox, and ensures
7+
# we are only ever declaring our dependencies in one place.
8+
9+
-r requirements/requirements-optionals.txt
10+
-r requirements/requirements-testing.txt
11+
-r requirements/requirements-documentation.txt
12+
-r requirements/requirements-codestyle.txt
13+
-r requirements/requirements-packaging.txt
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
flake8==3.7.7
2+
flake8-isort==2.7.0
3+
isort==4.3.21
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
recommonmark==0.6.0
2+
Sphinx==2.2.0
3+
sphinx_rtd_theme==0.4.3
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
django-filter==2.2.0
2+
django-polymorphic==2.1.2

0 commit comments

Comments
 (0)