Port to Poetry and Nox

.dockerignore

@@ -4,11 +4,9 @@
 # Except the following.
 !src
 !LICENSE.txt
-!MANIFEST.in
 !pyproject.toml
+!poetry.lock
 !README.md
-!requirements.txt
-!setup.py
 
 # Filter unwanted files from included folders.
 **/__pycache__

.github/workflows/pages.yml

@@ -11,12 +11,15 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
         with:
           python-version: "3.9"
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install tox
-      - run: tox -e docs-github-pages
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+      - name: Install Poetry
+        run: pipx install poetry
+      - name: Install all dependencies, including Nox
+        run: poetry install --no-root
+      - name: Publish Docs
+        run: poetry run nox -s docs_github_pages

.github/workflows/python.yml

@@ -3,20 +3,22 @@ name: python
 on: [push, pull_request]
 
 jobs:
-  tox:
+  nox:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [ "3.8", "3.9", "3.10" ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install tox tox-gh-actions
-      - name: Test with tox
-        run: tox
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+      - name: Install Poetry
+        run: pipx install poetry
+      - name: Install all dependencies, including Nox
+        run: poetry install --no-root
+      - name: Test with Nox
+        run: poetry run nox

.gitignore

@@ -1,14 +1,13 @@
-*.egg-info
-.tox
 .idea
-__pycache__
-.coverage
-.coverage.*
-htmlcov
-*.pyc
-venv
-dist
-.pytest_cache
 .mypy_cache
+.nox
+.pytest_cache
+dist
 build
+htmlcov
 site
+__pycache__
+*.pyc
+*.egg-info
+.coverage
+.coverage.*

Dockerfile

@@ -10,6 +10,9 @@
 #     will need to be recompiled fully within the Docker images, increasing build times.
 FROM python:3.9-slim-bullseye AS python_builder
 
+# Pin Poetry to a specific version to make Docker builds reproducible.
+ENV POETRY_VERSION 1.1.13
+
 # Set ENV variables that make Python more friendly to running inside a container.
 ENV PYTHONDONTWRITEBYTECODE 1
 ENV PYTHONBUFFERED 1
@@ -31,21 +34,32 @@ WORKDIR ${WORKDIR}
 #    gcc \
 #    && rm -rf /var/lib/apt/lists/*
 
+# Install Poetry into the global environment to isolate it from the venv. This prevents Poetry
+# from uninstalling parts of itself.
+# TODO: Improve Poetry usage in multi-stage Dockerfiles once these issues are fixed in Poetry.
+#   Non-editable `poetry install`: https://github.com/python-poetry/poetry/issues/1382
+#   Specifying venv path: https://github.com/python-poetry/poetry/issues/1579
+RUN pip install "poetry==${POETRY_VERSION}"
+
+# Copy in project dependency specification.
+COPY pyproject.toml poetry.lock ./
+RUN poetry export --output requirements.txt
+
 # Pre-download/compile wheel dependencies into a virtual environment.
 # Doing this in a multi-stage build allows ommitting compile dependencies from the final image.
 RUN python -m venv ${VIRTUAL_ENV}
 ENV PATH "${VIRTUAL_ENV}/bin:${PATH}"
 
-COPY requirements.txt ${WORKDIR}
 RUN pip install --upgrade pip wheel && \
     pip install -r requirements.txt
 
 # Copy in source files.
-COPY LICENSE.txt MANIFEST.in pyproject.toml README.md requirements.txt setup.py ./
+COPY README.md ./
 COPY src src
 
-# Install console script.
-RUN pip install .
+# Don't install the package itself with Poetry because it will install it as an editable install.
+RUN poetry build && \
+    pip install dist/*.whl
 
 ## Final Image
 # The image used in the final image MUST match exactly to the python_builder image.