Refactor: move dependencies and metadata to pyproject.toml (#1356)

.devcontainer/Dockerfile

@@ -1,15 +1,12 @@
 FROM benefits_client:latest
 
 # install devcontainer requirements
-COPY .devcontainer/requirements.txt .devcontainer/requirements.txt
-RUN pip install -r .devcontainer/requirements.txt
+RUN pip install -e .[dev,test]
 
+# docs requirements are in a separate file for the GitHub Action
 COPY docs/requirements.txt docs/requirements.txt
 RUN pip install -r docs/requirements.txt
 
-COPY tests/pytest/requirements.txt tests/pytest/requirements.txt
-RUN pip install -r tests/pytest/requirements.txt
-
 # install pre-commit environments in throwaway Git repository
 # https://stackoverflow.com/a/68758943
 COPY .pre-commit-config.yaml .

.devcontainer/devcontainer.json

@@ -20,6 +20,7 @@
       },
       // Add the IDs of extensions you want installed when the container is created.
       "extensions": [
+        "bungcip.better-toml",
         "batisteo.vscode-django",
         "bpruitt-goddard.mermaid-markdown-syntax-highlighting",
         "eamodio.gitlens",

.dockerignore

@@ -5,3 +5,4 @@
 .flake8
 .*ignore
 *.db
+*.egg-info

.github/dependabot.yml

@@ -6,7 +6,7 @@
 version: 2
 updates:
   - package-ecosystem: "pip"
-    directory: "/appcontainer" # main requirements.txt
+    directory: "/" # pyproject.toml
     schedule:
       interval: "daily"
     commit-message:

.github/workflows/labeler-deploy-dev.yml

@@ -5,11 +5,11 @@ on:
     branches: [dev]
     types: [opened]
     paths:
-      - '.github/workflows/deploy-*.yml'
-      - 'benefits/**'
-      - 'bin/**'
+      - ".github/workflows/deploy-*.yml"
+      - "benefits/**"
+      - "bin/**"
       - Dockerfile
-      - requirements.txt
+      - pyproject.toml
 
 jobs:
   label-deployment-dev:

.github/workflows/tests-pytest.yml

@@ -18,10 +18,10 @@ jobs:
         with:
           python-version-file: .github/workflows/.python-version
           cache: pip
-          cache-dependency-path: "**/requirements.txt"
+          cache-dependency-path: "**/pyproject.toml"
 
       - name: Install Python dependencies
-        run: pip install -r appcontainer/requirements.txt -r tests/pytest/requirements.txt
+        run: pip install -e .[test]
 
       - name: Run setup
         run: ./bin/init.sh

appcontainer/Dockerfile

@@ -1,15 +1,15 @@
 FROM ghcr.io/cal-itp/docker-python-web:main
 
-# install python dependencies
-COPY appcontainer/requirements.txt requirements.txt
-RUN pip install -r requirements.txt
+# upgrade pip
+RUN python -m pip install --upgrade pip
 
-# copy Django utility script
+# copy source files
 COPY manage.py manage.py
+COPY bin bin
+COPY benefits benefits
+COPY pyproject.toml pyproject.toml
 
-# copy source files
-COPY bin/ bin/
-COPY benefits/ benefits/
+RUN pip install -e .
 
 # ensure $USER can compile messages in the locale directories
 USER root

pyproject.toml

@@ -1,17 +1,53 @@
-# NOTE: you have to use single-quoted strings in TOML for regular expressions.
-# It's the equivalent of r-strings in Python.  Multiline strings are treated as
-# verbose regular expressions by Black.  Use [ ] to denote a significant space
-# character.
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
 
-# Configuration for black
+[project]
+classifiers = ["Programming Language :: Python :: 3 :: Only"]
+description = "Cal-ITP Benefits is an application that enables automated eligibility verification and enrollment for transit benefits onto customers’ existing contactless bank (credit/debit) cards."
+dependencies = [
+    "Authlib==1.2.0",
+    "Django==4.2",
+    "django-csp==3.7",
+    "eligibility-api==2023.01.1",
+    "requests==2.28.2",
+    "sentry-sdk==1.19.1",
+    "six==1.16.0",
+]
+dynamic = ["version"]
+keywords = ["django"]
+license = { file = "LICENSE" }
+name = "benefits"
+readme = "README.md"
+requires-python = ">=3.9"
+
+[project.optional-dependencies]
+dev = [
+    "black",
+    "djlint",
+    "flake8",
+    "pre-commit",
+]
+test = [
+    "pytest",
+    "pytest-cov",
+    "pytest-django",
+    "pytest-mock",
+    "pytest-socket",
+]
 
+[project.urls]
+Code = "https://github.com/cal-itp/benefits"
+Documentation = "https://docs.calitp.org/benefits"
+Issues = "https://github.com/cal-itp/benefits/issues"
+
+# Configuration for black
 [tool.black]
 line-length = 127
 target-version = ['py310']
 include = '\.pyi?$'
 
 # Configuration for djlint
-
 [tool.djlint]
 ignore = "H017,H031"
 indent = 2
@@ -22,7 +58,6 @@ preserve_blank_lines = true
 use_gitignore = true
 
 # Configuration for pytest
-
 [tool.coverage.run]
 omit = [
     "benefits/core/migrations/*"
@@ -33,3 +68,6 @@ DJANGO_SETTINGS_MODULE = "benefits.settings"
 markers = [
     "request_path: use with session_request to initialize with the given path",
 ]
+
+[tool.setuptools]
+packages = ["benefits"]