feat(#2737): Switch to Poetry in CI pipelines

.github/workflows/accessibility.yml

@@ -10,7 +10,7 @@ jobs:
     continue-on-error: true # currently we expect these tests to fail
     strategy:
       matrix:
-        python-version: ["3.11"]
+        python-version: ["3.12"]
         # two options for package: "pa11y" and "lighthouse"
         # both options use axe-core ruleset for a11y tests
         # pa11y runs faster and produces smaller artifacts
@@ -55,34 +55,36 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install pipenv
-          pipenv sync --dev
+          python -m pip install pipx
+          python -m pipx ensurepath
+          pipx install poetry==2.0.0
+          poetry sync
 
       - name: Set up Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Install NodeJS dependencies
         run: npm install
 
       - name: Check migrations
         run: |
-          pipenv run python manage.py makemigrations --dry-run --check;
+          poetry run python manage.py makemigrations --dry-run --check;
           if [[ $? != "0" ]]; then
             exit 1;
           fi;
 
       - name: Collect static files
         run: |
-          pipenv run python manage.py collectstatic --no-input;
+          poetry run python manage.py collectstatic --no-input;
           if [[ $? != "0" ]]; then
             exit 1;
           fi;
 
       - name: Set up dev database
         run: |
-          echo "yes" | pipenv run make dev_database
+          echo "yes" | poetry run make dev_database
 
       - name: Set up Chromium
         id: setup-chrome
@@ -112,7 +114,7 @@ jobs:
 
       - name: Start server in background
         run: |
-          pipenv run make serve &
+          poetry run make serve &
         if: matrix.package == 'pa11y'
 
       - name: Run pa11y

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.11' ]
+        python-version: [ '3.12' ]
         test-type: ["Unit", "Migration"]
       fail-fast: false
 
@@ -39,15 +39,17 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install pipenv
-        pipenv sync --dev
+        python -m pip install pipx
+        python -m pipx ensurepath
+        pipx install poetry==2.0.0
+        poetry sync
 
     - name: Install NodeJS dependencies
       run: npm install
 
     - name: Check migrations
       run: |
-        pipenv run python manage.py makemigrations --dry-run --check;
+        poetry run python manage.py makemigrations --dry-run --check;
         if [[ $? != "0" ]]; then
           exit 1;
         fi;
@@ -60,7 +62,7 @@ jobs:
 
     - name: Create cache tables
       run: |
-        pipenv run python manage.py createcachetable
+        poetry run python manage.py createcachetable
       env:
         AMY_DATABASE_HOST: localhost
         AMY_DATABASE_PORT: 5432
@@ -70,13 +72,13 @@ jobs:
 
     - name: Collect static files
       run: |
-        pipenv run python manage.py collectstatic --no-input;
+        poetry run python manage.py collectstatic --no-input;
         if [[ $? != "0" ]]; then
           exit 1;
         fi;
 
     - name: Unit tests
-      run: pipenv run make test
+      run: poetry run make test
       env:
         AMY_DATABASE_HOST: localhost
         AMY_DATABASE_PORT: 5432
@@ -86,7 +88,7 @@ jobs:
       if: matrix.test-type == 'Unit'
 
     - name: Migration tests
-      run: pipenv run make test_migrations
+      run: poetry run make test_migrations
       env:
         AMY_DATABASE_HOST: localhost
         AMY_DATABASE_PORT: 5432

README.md

@@ -48,22 +48,17 @@ sudo apt-get install python3-dev libpq-dev
     git config blame.ignoreRevsFile .git-blame-ignore-revs
     ~~~
 
-1. Install [Pipenv](https://pipenv.pypa.io/en/latest/):
-
-    ~~~
-    python -m pip install --user pipenv
-    ~~~
+1. Install [Poetry](https://python-poetry.org/docs/#installation).
 
 1. Install Python dependencies:
 
     ~~~
-    pipenv sync --dev
+    poetry install
     ~~~
 
     **Note:**
-    Pipenv will create a new virtual environment for this installation, so you don't
+    Poetry will create a new virtual environment for this installation, so you don't
     have to create one yourself.
-    The `--dev` flag installs development dependencies, required e.g. for testing.
 
 1. Install [node][nodejs] for front-end packages management.
 
@@ -77,21 +72,21 @@ sudo apt-get install python3-dev libpq-dev
 1. Create a local instance of Postgres (in a container). This requires Docker to be installed locally.
 
     ~~~
-    make database
+    poetry run make database
     ~~~
 
 1. Note: if the database container already exists, the above command will error out. Use `docker start amy-database` instead to start the database container.
 
 1. Set up your local database with fake (development-ready) data.  This will create a superuser with "admin" as both the username and password.
 
     ~~~
-    pipenv run make dev_database
+    poetry run make dev_database
     ~~~
 
 1. Start a local Django development server by running:
 
     ~~~
-    pipenv run make serve
+    poetry run make serve
     ~~~
 
     **Note**:  this also installs front-end dependencies for AMY, including [jQuery][jquery] and [Bootstrap][bootstrap] ([full list here](https://github.com/carpentries/amy/blob/develop/package.json)).
@@ -108,14 +103,14 @@ sudo apt-get install python3-dev libpq-dev
 
 ```shell
 LAST_COMMIT=`git rev-parse --short HEAD`
-docker build -t amy:latest -t amy:${LAST_COMMIT} --label commit=${LAST_COMMIT} -f docker/Dockerfile .
+docker build -t amy:latest -t amy:$LAST_COMMIT --label commit=$LAST_COMMIT .
 ```
 
 First command sets `LAST_COMMIT` environment variable to short commit hash of the
 last commit in the repository.
 
-Second command builds `docker/Dockerfile` in `.` as a context (should be your repository
-directory) with tags `amy:latest` and `amy:LAST_COMMIT`.
+Second command builds `Dockerfile` in `.` as a context (should be your repository
+directory) with tags `amy:latest` and `amy:$LAST_COMMIT`.
 
 ## Upgrading
 
@@ -142,7 +137,7 @@ directory) with tags `amy:latest` and `amy:LAST_COMMIT`.
 1. Update back-end dependencies:
 
     ~~~
-    pipenv sync --dev
+    poetry sync
     ~~~
 
 1. Update front-end dependencies:
@@ -154,19 +149,19 @@ directory) with tags `amy:latest` and `amy:LAST_COMMIT`.
 1. (Optional) make fresh development-ready database:
 
     ~~~
-    pipenv run make dev_database
+    poetry run make dev_database
     ~~~
 
 1. Run database migrations (note: this is included in the `make dev_database` step above):
 
     ~~~~
-    pipenv run python manage.py migrate
+    poetry run python manage.py migrate
     ~~~~
 
 1. Enjoy your new version of AMY:
 
     ~~~
-    pipenv run make serve
+    poetry run make serve
     ~~~
 
 

lighthouserc.js

@@ -71,7 +71,7 @@ module.exports = {
                 "http://127.0.0.1:8000/workshops/workshop_staff/",
                 "http://127.0.0.1:8000/account/logout/"
             ],
-            startServerCommand: 'pipenv run make serve',
+            startServerCommand: 'poetry run make serve',
             puppeteerScript: 'puppeteer-script.js',
             numberOfRuns: 1
         },
@@ -86,4 +86,4 @@ module.exports = {
             }
         }
     }
-};
+};