Refactored reqs (#603)

Co-authored-by: Chris Clark <[email protected]>

MANIFEST.in

@@ -1,5 +1,6 @@
 recursive-include explorer *
 recursive-exclude * *.pyc __pycache__ .DS_Store
+recursive-include requirements *
 include package.json
 include vite.config.js
 include README.rst

requirements/base.txt

@@ -1,5 +1,3 @@
+Django>=3.2
 sqlparse>=0.4.0
-coverage
-factory-boy>=3.1.0
-requests~=2.31.0
-sql_metadata>=2.10
+requests>=2.2

requirements/dev.txt

@@ -0,0 +1,9 @@
+-r ./base.txt
+-r ./extra/assistant.txt
+-r ./extra/charts.txt
+-r ./extra/snapshots.txt
+-r ./extra/xls.txt
+
+importlib-metadata<5.0; python_version <= '3.7'
+coverage
+factory-boy>=3.1.0

requirements/extra/assistant.txt

@@ -0,0 +1,3 @@
+openai>=1.6.1
+sql_metadata>=2.10
+tiktoken>=0.6

requirements/extra/charts.txt

@@ -0,0 +1,2 @@
+matplotlib<4
+seaborn<0.12

requirements/extra/snapshots.txt

@@ -0,0 +1,2 @@
+boto3>=1.20.0
+celery>=4.0

requirements/extra/xls.txt

@@ -0,0 +1 @@
+xlsxwriter>=1.3.6

setup.py

@@ -16,8 +16,10 @@
 release = get_version(True)
 
 
-def read(fname):
-    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+def requirements(fname):
+    path = os.path.join(os.path.dirname(__file__), "requirements", fname)
+    with open(path) as f:
+        return f.read().splitlines()
 
 
 if sys.argv[-1] == "build":
@@ -74,26 +76,13 @@ def read(fname):
     ],
     python_requires=">=3.8",
     install_requires=[
-        "Django>=3.2",
-        "sqlparse>=0.4.0",
-        "requests>=2.2",
+        requirements("base.txt"),
     ],
     extras_require={
-        "charts": [
-            "matplotlib<4",
-            "seaborn<0.12"
-        ],
-        "snapshots": [
-            "boto3>=1.20.0",
-            "celery>=4.0"
-        ],
-        "xls": [
-            "xlsxwriter>=1.3.6"
-        ],
-        "assistant": [
-            "openai>=1.6.1",
-            "tiktoken>=0.6"
-        ]
+        "charts": requirements("extra/charts.txt"),
+        "snapshots": requirements("extra/snapshots.txt"),
+        "xls": requirements("extra/xls.txt"),
+        "assistant": requirements("extra/assistant.txt"),
     },
     cmdclass={
         "build_sphinx": BuildDoc,

test_project/start.sh

@@ -1,7 +1,6 @@
 #!/bin/bash
 
-pip install -r ../requirements/base.txt
-pip install -r ../requirements/optional.txt
+pip install -r ../requirements/dev.txt
 pip install django
 
 python ../manage.py migrate

tox.ini

@@ -2,20 +2,20 @@
 envlist =
     flake8
     isort
-    {base-reqs,optional}-py{310,311,312}-dj{32,42,50}
-    {base-reqs,optional}-py{311,312}-dj{50,main}
+    {base-reqs,dev}-py{310,311,312}-dj{32,42,50}
+    {base-reqs,dev}-py{311,312}-dj{50,main}
 
 skip_missing_interpreters=True
 
 [testenv]
 allowlist_externals = coverage
 deps =
-    base-reqs: -r requirements/base.txt
+    base-reqs: -r requirements/dev.txt
     dj32: django>=3.2,<4.0
     dj42: django>=4.2,<5.0
     dj50: django>=5.0,<5.1
     djmain: https://github.com/django/django/archive/main.tar.gz
-    optional: -r requirements/optional.txt
+    dev: -r requirements/dev.txt
 commands =
     {envpython} --version
     {env:COMMAND:coverage} run manage.py test --settings=tests.settings --noinput