Convert to use Poetry for Python dependency management (#1060)

Author: blarghmatey

.github/workflows/ci.yml

@@ -32,28 +32,28 @@ jobs:
 
       - name: Apt install
         run: cat Aptfile | sudo xargs apt-get install
+        
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.5.1
+          virtualenvs-create: true
+          virtualenvs-in-project: true
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: "3.9.13"
-
-      - id: cache
-        uses: actions/cache@v1
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt', '**/test_requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+          cache: poetry
 
       - name: Install dependencies
-        run: pip install -r requirements.txt -r test_requirements.txt
+        run: poetry install --no-interaction
 
       - name: Code formatting
-        run: black --check .
+        run: poetry run black --check .
 
       - name: Lint
-        run: pylint ./**/*.py
+        run: poetry run pylint ./**/*.py
 
       - name: Tests
         run: |

.pre-commit-config.yaml

@@ -4,4 +4,4 @@ repos:
     hooks:
     -   id: detect-secrets
         args: ['--baseline', '.secrets.baseline']
-        exclude: .*_test.*|.*\.rst
+        exclude: .*_test.*|.*\.rst|poetry.lock

Dockerfile

@@ -27,19 +27,27 @@ RUN mkdir /src
 RUN adduser --disabled-password --gecos "" mitodl
 RUN mkdir /var/media && chown -R mitodl:mitodl /var/media
 
+# Poetry env configuration
+ENV  \
+  # poetry:
+  POETRY_VERSION=1.5.1 \
+  POETRY_VIRTUALENVS_CREATE=false \
+  POETRY_CACHE_DIR='/tmp/cache/poetry'
+
+# Install poetry
+RUN pip install "poetry==$POETRY_VERSION"
+
 # Install project packages
-COPY requirements.txt /tmp/requirements.txt
-RUN pip install -r requirements.txt
+COPY pyproject.toml /src
+COPY poetry.lock /src
+WORKDIR /src
+RUN poetry install --no-dev
 
 # Add project
 COPY . /src
-WORKDIR /src
 RUN chown -R mitodl:mitodl /src
 USER mitodl
 
-# Set pip cache folder, as it is breaking pip when it is on a shared volume
-ENV XDG_CACHE_HOME /tmp/.cache
-
 EXPOSE 8089
 ENV PORT 8089
 CMD uwsgi uwsgi.ini
@@ -56,7 +64,5 @@ USER mitodl
 # like to run alone for some reasont
 FROM base AS development
 USER root
-COPY test_requirements.txt /tmp/test_requirements.txt
-RUN pip install -r /tmp/requirements.txt -r /tmp/test_requirements.txt
-RUN chown -R mitodl:mitodl /tmp/.cache
+RUN poetry install
 USER mitodl

conftest.py

@@ -24,7 +24,11 @@ def warnings_as_errors():
             message="'async' and 'await' will become reserved keywords in Python 3.7",
             category=DeprecationWarning,
         )
-
+        warnings.filterwarnings(
+            "ignore",
+            message="stream argument is deprecated. Use stream parameter in request directly",
+            category=DeprecationWarning,
+        )
         yield
     finally:
         warnings.resetwarnings()

docker-compose.yml

@@ -43,7 +43,7 @@ services:
       DOCKER_HOST: ${DOCKER_HOST:-missing}
       WEBPACK_DEV_SERVER_HOST: ${WEBPACK_DEV_SERVER_HOST:-localhost}
       DOCKER_HOST: ${DOCKER_HOST:-missing}
-      FIELD_ENCRYPTION_KEY: jtma0CL1QMRLaJgjXNlJh3mtPNcgok0G5ajRCMZ_XNI=
+      FIELD_ENCRYPTION_KEY: jtma0CL1QMRLaJgjXNlJh3mtPNcgok0G5ajRCMZ_XNI=  # pragma: allowlist secret
     env_file: .env