feat!: use poetry instead of setup.py

.github/workflows/check.yml

@@ -25,30 +25,31 @@ jobs:
           - '3.9'
           - '3.10'
           - '3.11'
+          - '3.12'
     runs-on: ${{ matrix.os }}
-    name: Run tests on Python ${{ matrix.python-version }}, on ${{ matrix.os }}
+    name: Test on Python ${{ matrix.python-version }}, on ${{ matrix.os }}
     timeout-minutes: 45
-    concurrency:
-      group: ${{ github.workflow }}-run-unit-tests-${{ matrix.python-version }}-${{ matrix.os }}-${{ github.event.number || github.ref }}
-      cancel-in-progress: true
     steps:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Checkout code
+      - name: Checkout Code
         uses: actions/checkout@v4
 
-      - name: Restore Python dependencies
-        run: |
-          pip install -r requirements-dev.txt
+      - name: Install Poetry
+        run: pip install -r requirements.txt
+
+      - name: Restore Development Environment
+        run: poetry install
 
       - name: Test
-        run: python -m unittest discover -s test -t .
+        shell: bash
+        run: poetry run poe test
+
   deploy:
     needs:
       - test
     uses: ./.github/workflows/deploy.yml
-    if: github.ref_name == 'master' || github.ref_name == 'main'
     secrets: inherit

.github/workflows/deploy.yml

@@ -9,7 +9,7 @@ jobs:
       group: deploy
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
+      - name: Checkout Code
         uses: actions/checkout@v4
         with:
           fetch-depth: 0 # all history
@@ -21,13 +21,11 @@ jobs:
         id: get-python-version
         run: echo version=$(python setup.py get_minimum_python_version | tail -n 1) >> $GITHUB_OUTPUT
 
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ steps.get-python-version.outputs.version }}
+      - name: Install Poetry
+        run: pip install -r requirements.txt
 
-      - name: Restore Python dependencies
-        run: pip install -r requirements-dev.txt
+      - name: Restore Development Environment
+        run: poetry install
 
       - name: Change default logging level
         run: sed -i -e 's/DEBUG/WARN/g' my_project/__init__.py
@@ -48,4 +46,5 @@ jobs:
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
           TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
           GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
-          RELEASE_DRY_RUN: ${{ contains(github.repository, 'template') }}
+          RELEASE_TEST_PYPI: ${{ contains(github.repository, 'template') }}
+          RELEASE_DRY_RUN: ${{ github.ref_name != 'master' && github.ref_name != 'main' }}

.gitignore

@@ -1,4 +1,4 @@
-VERSION
+node_modules/
 
 tmp/
 .idea/

.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./test",
+        "-p",
+        "*.py"
+    ],
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true,
+    "python.testing.autoTestDiscoverOnSaveEnabled": true,
+}

my_project/__init__.py

@@ -12,5 +12,13 @@ def my_method(self):
         return "Hello World"
 
 
+def main():
+    # this is the main module of your app
+    # it is only required if your project must be runnable
+    # this is the script to be executed whenever some users writes `python -m my_project` on the command line, eg.
+    x = MyClass().my_method()
+    print(x)
+
+
 # let this be the last line of this file
 logger.info("my_project loaded")

my_project/__main__.py

@@ -1,7 +1,3 @@
 import my_project
 
-# this is the main module of your app
-# it is only required if your project must be runnable
-# this is the script to be executed whenever some users writes `python -m my_project` on the command line, eg.
-x = my_project.MyClass().my_method()
-print(x)
+my_project.main()