os: Use pipx to install poetry (#585)

* This is the recommended installation method for poetry
https://python-poetry.org/docs/#installation
* Makes `poetry` available in the $PATH for developers

Author: sonnyp

.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: https://editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab

.github/workflows/documentation-build.yml

@@ -14,6 +14,7 @@ on:
     paths:
       - 'documentation/**'
       - 'hardware/**'
+      - '.github/workflows/documentation-build.yml'
   merge_group:
   workflow_dispatch:
     inputs:
@@ -47,7 +48,7 @@ jobs:
 
       # Build documentation website
       - name: Install poetry
-        run: pipx install poetry==1.7.1
+        run: pipx install poetry==2.1.2
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -59,17 +60,20 @@ jobs:
 
       - name: Install build dependencies
         run: |
-          poetry -C ./documentation/ install
+          poetry -C ./documentation/ install --no-root
 
       - name: Make documentation ${{ matrix.variant }}
         if: matrix.variant != 'default'
-        run: poetry -C ./documentation/ run poe --root ./documentation/ make-${{ matrix.variant }}
+        working-directory: documentation
+        run: poetry run poe make-${{ matrix.variant }}
 
       - name: Check documentation
-        run: poetry -C ./documentation/ run poe --root ./documentation/ check
+        working-directory: documentation
+        run: poetry run poe check
 
       - name: Build documentation
-        run: poetry -C ./documentation/ run poe --root ./documentation/ build
+        working-directory: documentation
+        run: poetry run poe build
 
       # Work around a bug where capital letters in the GitHub username (e.g. "PlanktoScope") make it
       # impossible to push to GHCR. See https://github.com/macbre/push-to-ghcr/issues/12

.github/workflows/documentation-deploy-beta.yml

@@ -37,7 +37,7 @@ jobs:
           sudo apt-get -y install pngquant
 
       - name: Install poetry
-        run: pipx install poetry==1.7.1
+        run: pipx install poetry==2.1.2
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -49,16 +49,19 @@ jobs:
 
       - name: Install build dependencies
         run: |
-          poetry -C ./documentation/ install --with imaging
+          sudo apt install libjpeg-dev
+          poetry -C ./documentation/ install --with imaging --no-root
 
       - name: Set release channel
-        run: poetry -C ./documentation/ run poe --root ./documentation/ set-beta-release-channel
+        working-directory: documentation
+        run: poetry run poe set-beta-release-channel
 
       - name: Build documentation
         env:
           DOCS_DEPLOY: true
           DOCS_SITEURL: ${{ vars.URL }}
-        run: poetry -C ./documentation/ run poe --root ./documentation/ build
+        working-directory: documentation
+        run: poetry run poe build
 
       - name: Push to ${{ vars.REPOSITORY_NAME }}
         uses: cpina/github-action-push-to-another-repository@main

.github/workflows/documentation-deploy-edge.yml

@@ -42,7 +42,7 @@ jobs:
           sudo apt-get -y install pngquant
 
       - name: Install poetry
-        run: pipx install poetry==1.7.1
+        run: pipx install poetry==2.1.2
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -54,16 +54,19 @@ jobs:
 
       - name: Install build dependencies
         run: |
-          poetry -C ./documentation/ install --with imaging
+          sudo apt install libjpeg-dev
+          poetry -C ./documentation/ install --with imaging --no-root
 
       - name: Set release channel
-        run: poetry -C ./documentation/ run poe --root ./documentation/ set-edge-release-channel
+        working-directory: documentation
+        run: poetry run poe set-edge-release-channel
 
       - name: Build documentation
         env:
           DOCS_DEPLOY: true
           DOCS_SITEURL: ${{ vars.URL }}
-        run: poetry -C ./documentation/ run poe --root ./documentation/ build
+        working-directory: documentation
+        run: poetry run poe build
 
       - name: Set up Pages
         id: pages

.github/workflows/documentation-deploy-stable.yml

@@ -37,7 +37,7 @@ jobs:
           sudo apt-get -y install pngquant
 
       - name: Install poetry
-        run: pipx install poetry==1.7.1
+        run: pipx install poetry==2.1.2
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -48,14 +48,17 @@ jobs:
             documentation/poetry.lock
 
       - name: Install build dependencies
+        working-directory: documentation
         run: |
-          poetry -C ./documentation/ install --with imaging
+          sudo apt install libjpeg-dev
+          poetry install --with imaging --no-root
 
       - name: Build documentation
         env:
           DOCS_DEPLOY: true
           DOCS_SITEURL: ${{ vars.URL }}
-        run: poetry -C ./documentation/ run poe --root ./documentation/ build
+        working-directory: documentation
+        run: poetry run poe build
 
       - name: Push to ${{ vars.REPOSITORY_NAME }}
         uses: cpina/github-action-push-to-another-repository@main

documentation/README.md

@@ -64,12 +64,6 @@ cd /some/path/here/PlanktoScope/documentation
 poetry run poe build
 ```
 
-If you really don't want to change your current working directory to `/some/path/here/PlanktoScope/documentation`, you can instead run the following command:
-
-```
-poetry -C /some/path/here/PlanktoScope/documentation/ run poe --root /some/path/here/PlanktoScope/documentation/ build
-```
-
 (this also works for `preview`, `check`, and any other subcommands of `poe`)
 
 #### Publishing your changes