Skip to content

remove django from base requirements #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
UsamaSadiq merged 1 commit into from
May 18, 2021
Merged

remove django from base requirements #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ upgrade: ## update the requirements/*.txt files with the latest packages satisfy
# Make sure to compile files after any other files they include!
pip-compile --upgrade -o requirements/pip-tools.txt requirements/pip-tools.in
pip-compile --upgrade -o requirements/base.txt requirements/base.in
pip-compile --upgrade -o requirements/django.txt requirements/django.in
pip-compile --upgrade -o requirements/test.txt requirements/test.in
pip-compile --upgrade -o requirements/doc.txt requirements/doc.in
pip-compile --upgrade -o requirements/quality.txt requirements/quality.in
Expand Down
1 change: 0 additions & 1 deletion requirements/base.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
-c constraints.txt

click>=7.0,<8.0
Django # Web application framework
Jinja2
pyyaml
python-slugify
Expand Down
14 changes: 6 additions & 8 deletions requirements/base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,23 @@
# make upgrade
#
click==7.1.2
# via -r requirements/base.in
django==2.2.22
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/base.in
jinja2==2.11.3
# via -r requirements/base.in
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/base.in
markupsafe==1.1.1
# via jinja2
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# jinja2
pbr==5.6.0
# via stevedore
python-slugify==5.0.2
# via -r requirements/base.in
pytz==2021.1
# via django
pyyaml==5.4.1
# via -r requirements/base.in
sqlparse==0.4.1
# via django
stevedore==3.3.0
# via -r requirements/base.in
text-unidecode==1.3
Expand Down
1 change: 0 additions & 1 deletion requirements/constraints.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@

# Common constraints for edx repos
-c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt

14 changes: 9 additions & 5 deletions requirements/dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ click-log==0.3.2
# edx-lint
click==7.1.2
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/pip-tools.txt
# -r requirements/quality.txt
# click-log
Expand All @@ -44,19 +45,19 @@ code-annotations==1.1.1
# edx-lint
codecov==2.1.11
# via -r requirements/travis.txt
coverage==5.5
coverage[toml]==5.5
# via
# -r requirements/quality.txt
# -r requirements/travis.txt
# codecov
# pytest-cov
diff-cover==5.1.0
diff-cover==5.1.1
# via -r requirements/dev.in
distlib==0.3.1
# via
# -r requirements/travis.txt
# virtualenv
django==2.2.22
django==2.2.23
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/quality.txt
Expand Down Expand Up @@ -87,6 +88,7 @@ jinja2-pluralize==0.3.0
# via diff-cover
jinja2==2.11.3
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/quality.txt
# code-annotations
# diff-cover
Expand All @@ -97,6 +99,7 @@ lazy-object-proxy==1.6.0
# astroid
markupsafe==1.1.1
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/quality.txt
# jinja2
mccabe==0.6.1
Expand Down Expand Up @@ -136,7 +139,7 @@ py==1.10.0
# tox
pycodestyle==2.7.0
# via -r requirements/quality.txt
pydocstyle==6.0.0
pydocstyle==6.1.1
# via -r requirements/quality.txt
pygments==2.9.0
# via diff-cover
Expand Down Expand Up @@ -165,7 +168,7 @@ pyparsing==2.4.7
# -r requirements/quality.txt
# -r requirements/travis.txt
# packaging
pytest-cov==2.11.1
pytest-cov==2.12.0
# via -r requirements/quality.txt
pytest==6.2.4
# via
Expand Down Expand Up @@ -215,6 +218,7 @@ toml==0.10.2
# -r requirements/pip-tools.txt
# -r requirements/quality.txt
# -r requirements/travis.txt
# coverage
# pep517
# pylint
# pytest
Expand Down
5 changes: 5 additions & 0 deletions requirements/django.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Additional Django dependencies for running django based annotation checks.

-c constraints.txt

django # Required for django apps & models annotations
14 changes: 14 additions & 0 deletions requirements/django.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#
# This file is autogenerated by pip-compile
# To update, run:
#
# make upgrade
#
django==2.2.23
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/django.in
pytz==2021.1
# via django
sqlparse==0.4.1
# via django
15 changes: 10 additions & 5 deletions requirements/doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ chardet==4.0.0
# doc8
# requests
click==7.1.2
# via -r requirements/test.txt
coverage==5.5
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
coverage[toml]==5.5
# via
# -r requirements/test.txt
# pytest-cov
django==2.2.22
django==2.2.23
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
Expand All @@ -51,10 +53,12 @@ iniconfig==1.1.1
# pytest
jinja2==2.11.3
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
# sphinx
markupsafe==1.1.1
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
# jinja2
# sphinx
Expand Down Expand Up @@ -87,7 +91,7 @@ pyparsing==2.4.7
# via
# -r requirements/test.txt
# packaging
pytest-cov==2.11.1
pytest-cov==2.12.0
# via -r requirements/test.txt
pytest==6.2.4
# via
Expand Down Expand Up @@ -116,7 +120,7 @@ six==1.16.0
# readme-renderer
snowballstemmer==2.1.0
# via sphinx
sphinx==4.0.0
sphinx==4.0.1
# via
# -r requirements/doc.in
# edx-sphinx-theme
Expand Down Expand Up @@ -147,6 +151,7 @@ text-unidecode==1.3
toml==0.10.2
# via
# -r requirements/test.txt
# coverage
# pytest
urllib3==1.26.4
# via requests
Expand Down
4 changes: 3 additions & 1 deletion requirements/pip-tools.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
# make upgrade
#
click==7.1.2
# via pip-tools
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# pip-tools
pep517==0.10.0
# via pip-tools
pip-tools==6.1.0
Expand Down
12 changes: 8 additions & 4 deletions requirements/quality.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,18 @@ click-log==0.3.2
# via edx-lint
click==7.1.2
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
# click-log
# code-annotations
# edx-lint
code-annotations==1.1.1
# via edx-lint
coverage==5.5
coverage[toml]==5.5
# via
# -r requirements/test.txt
# pytest-cov
django==2.2.22
django==2.2.23
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
Expand All @@ -44,12 +45,14 @@ isort==5.8.0
# pylint
jinja2==2.11.3
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
# code-annotations
lazy-object-proxy==1.6.0
# via astroid
markupsafe==1.1.1
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
# jinja2
mccabe==0.6.1
Expand All @@ -74,7 +77,7 @@ py==1.10.0
# pytest
pycodestyle==2.7.0
# via -r requirements/quality.in
pydocstyle==6.0.0
pydocstyle==6.1.1
# via -r requirements/quality.in
pylint-celery==0.3
# via edx-lint
Expand All @@ -94,7 +97,7 @@ pyparsing==2.4.7
# via
# -r requirements/test.txt
# packaging
pytest-cov==2.11.1
pytest-cov==2.12.0
# via -r requirements/test.txt
pytest==6.2.4
# via
Expand Down Expand Up @@ -131,6 +134,7 @@ text-unidecode==1.3
toml==0.10.2
# via
# -r requirements/test.txt
# coverage
# pylint
# pytest
wrapt==1.12.1
Expand Down
1 change: 1 addition & 0 deletions requirements/test.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Requirements for test runs.

-c constraints.txt
-r django.txt # Django dependencies for additional checks
-r base.txt # Core dependencies for this package

pytest-cov # pytest extension for code coverage statistics
Expand Down
23 changes: 15 additions & 8 deletions requirements/test.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,23 @@
attrs==21.2.0
# via pytest
click==7.1.2
# via -r requirements/base.txt
coverage==5.5
# via pytest-cov
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/base.txt
coverage[toml]==5.5
# via pytest-cov
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/django.txt
iniconfig==1.1.1
# via pytest
jinja2==2.11.3
# via -r requirements/base.txt
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/base.txt
markupsafe==1.1.1
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/base.txt
# jinja2
mock==4.0.3
Expand All @@ -35,21 +40,21 @@ py==1.10.0
# via pytest
pyparsing==2.4.7
# via packaging
pytest-cov==2.11.1
pytest-cov==2.12.0
# via -r requirements/test.in
pytest==6.2.4
# via pytest-cov
python-slugify==5.0.2
# via -r requirements/base.txt
pytz==2021.1
# via
# -r requirements/base.txt
# -r requirements/django.txt
# django
pyyaml==5.4.1
# via -r requirements/base.txt
sqlparse==0.4.1
# via
# -r requirements/base.txt
# -r requirements/django.txt
# django
stevedore==3.3.0
# via -r requirements/base.txt
Expand All @@ -58,4 +63,6 @@ text-unidecode==1.3
# -r requirements/base.txt
# python-slugify
toml==0.10.2
# via pytest
# via
# coverage
# pytest
1 change: 1 addition & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ def is_requirement(line):
},
include_package_data=True,
install_requires=load_requirements('requirements/base.in'),
extras_require={"django": ["Django>=2.2,<2.3"]},
Copy link
Copy Markdown

@jmbowman jmbowman May 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slightly cleaner would be to use something like extras_require={"django": load_requirements('requirements/django.in')}, here, update Makefile to create django.txt from the new input file, and include -r django.txt in requirements/test.in. requirements/django.in would just contain an explanatory comment and the Django>=2.2,<2.3 constraint you have here. This would remove keep Django out of base.in, base.txt, and the core package dependencies while keeping the rest of the requirements files for testing and local development largely unchanged.

Copy link
Copy Markdown
Contributor

@regisb regisb May 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, much better.

Copy link
Copy Markdown
Member Author

@UsamaSadiq UsamaSadiq May 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the requirement files as per suggestion.

license="AGPL 3.0",
zip_safe=False,
keywords='edx pii code annotations',
Expand Down