build: Modernize dependency management

- Inline all requirements into `setup.py` - Dissolve all `requirements/*` files - Add Make target `install-develop` for installing the package in editable mode, for development purposes
ip-tools · Aug 25, 2023 · 7106f79 · 7106f79
1 parent 5972f19
commit 7106f79
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 321 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -48,7 +48,7 @@ jobs:
 
     - name: Setup project
       run: |
-        pip install -r requirements/test.txt
+        make install-develop
 
     - name: Run linter and software tests
       run: |

diff --git a/Makefile b/Makefile
@@ -15,6 +15,9 @@ help: ## Display this help message
 	@echo "Please use \`make <target>' where <target> is one of the following:"
 	@perl -nle'print $& if m{^[\.a-zA-Z_-]+:.*?## .*$$}' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}'
 
+install-develop: ## Install project into sandbox.
+	pip install --use-pep517 --prefer-binary --editable=.[develop,docs,test]
+
 seed-isort-config: ## Update known third party dependencies
 	seed-isort-config --application-directories .:epo_ops --exclude setup.py
 

diff --git a/docs/sandbox.md b/docs/sandbox.md
@@ -22,9 +22,9 @@ on behalf of a pull request, see the [contributing guidelines](contributing.md).
     source .venv/bin/activate
     ```
 
-3.  Install required Python packages.
+3.  Install required Python packages into development sandbox.
     ```shell
-    pip install -r requirements/dev.txt
+    make install-develop
     ```
 
 

diff --git a/requirements/base.in b/requirements/base.in
diff --git a/requirements/dev.in b/requirements/dev.in
diff --git a/requirements/dev.txt b/requirements/dev.txt
diff --git a/requirements/test.in b/requirements/test.in
diff --git a/requirements/test.txt b/requirements/test.txt
diff --git a/setup.py b/setup.py
@@ -16,7 +16,30 @@
 
 packages = ["epo_ops"]
 
-requires = ["python-dateutil", "requests", "six"]
+requires = [
+    "dogpile.cache<1.2",
+    "python-dateutil<2.9",
+    "requests>=2.27,<3",
+    "six<2",
+]
+extras = {
+    "develop": [
+        "black<24",
+        "bump2version<1.1",
+        "flake8<6",
+        "flake8-bugbear<22",
+        "isort<6",
+        "seed-isort-config<3",
+        "twine<5",
+        "wheel<1",
+    ],
+    "test": [
+        "pytest<8",
+        "pytest-cache<2",
+        "pytest-cov<4.2",
+        "python-dotenv<0.20",
+    ],
+}
 
 here = path.abspath(path.dirname(__file__))
 
@@ -45,7 +68,8 @@
     package_dir={"epo_ops": "epo_ops"},
     include_package_data=True,
     install_requires=requires,
-    tests_require=["pytest", "pytest-cache", "pytest-cov"],
+    extras_require=extras,
+    tests_require=extras["test"],
     zip_safe=False,
     classifiers=[
         "Development Status :: 5 - Production/Stable",