remove django from base requirements

[UsamaSadiq]

JIRA Issue: BOM-2418

Details:

Moving the Django requirement from base.in to django.in because:

• Django requirement in base.in causes the django version in testeng-ci repo to upgrade to django==3.1.6 which causes failures in different jobs.
• It upgrades the django version to 3+ in any repo that uses this package without applying constraint on django versions.

[regisb]

How can we achieve this when code-annotations does actually depend on Django? https://github.com/edx/code-annotations/blob/master/code_annotations/find_django.py#L10

[UsamaSadiq]

How can we achieve this when code-annotations does actually depend on Django? https://github.com/edx/code-annotations/blob/master/code_annotations/find_django.py#L10

@regisb thanks for pointing it out. I didn't look in detail as I thought tests would fail but it turns out I was wrong. @jmbowman since django is required in this package, then should I add the constraint in the base.in file or in the setup.py file instead? so it doesn't affect the other packages/repos which are using this package.

[jmbowman]

My preference would be to make those imports (and the code using them) fail gracefully when Django is not installed, since there shouldn't be any Django models in a package or service that doesn't depend on Django. Then Django would be an optional dependency of code-annotations rather than a required one. The goal here is to avoid introducing Django as a dependency to all our Python repositories that don't already use it (via the dependency of edx-lint on this package).

[UsamaSadiq]

My preference would be to make those imports (and the code using them) fail gracefully when Django is not installed, since there shouldn't be any Django models in a package or service that doesn't depend on Django. Then Django would be an optional dependency of code-annotations rather than a required one. The goal here is to avoid introducing Django as a dependency to all our Python repositories that don't already use it (via the dependency of edx-lint on this package).

Instead of completely removing the django dependency, I've moved it to the dev.in file so it will only be installed as this package's dependency and will not affect other packages which will use code-annotations.

[regisb]

Can I suggest instead adding an extra requirement to setup.py? https://setuptools.readthedocs.io/en/latest/userguide/dependency_management.html?highlight=extras_require#optional-dependencies

extras_require: {"django":  ["Django>=2.2"]}

This allows us to write pip install code-annotations[django], or add code-annotations[django] to any requirements.txt file. This is the "standard" way of doing things; I believe Django uses the same approach to install database-specific requirements.

[UsamaSadiq]

Can I suggest instead adding an extra requirement to setup.py? https://setuptools.readthedocs.io/en/latest/userguide/dependency_management.html?highlight=extras_require#optional-dependencies

extras_require: {"django":  ["Django>=2.2"]}

This allows us to write pip install code-annotations[django], or add code-annotations[django] to any requirements.txt file. This is the "standard" way of doing things; I believe Django uses the same approach to install database-specific requirements.

Added django dependency in extras_require as per suggestion.

[regisb]

Sorry for the late review!

[jmbowman]

One optional suggestion for further improvement, otherwise looks good!

[jmbowman]

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.

[regisb]

Indeed, much better.

[UsamaSadiq]

Updated the requirement files as per suggestion.