#314 - Switch to poetry

.coveragerc

@@ -1,8 +1,6 @@
 [run]
 source=cassis
 omit=
-    setup.py
     cassis/__init__.py
-    cassis/__version__.py
     tests/*
     docs/*

.github/workflows/publish_to_pypi.yml

@@ -15,13 +15,12 @@ jobs:
         python-version: '3.11'
     - name: Install dependencies
       run: |
-        pip install --upgrade -e .[test]
+        pip install poetry
+        make dependencies
     - name: Run tests
-      run: |
-        pytest
+      run: make unit-tests
     - name: Build package
-      run: |
-        python setup.py sdist
+      run: make build
     - name: Publish package to TestPyPI
       if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/run_tests.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
 
     steps:
     - uses: actions/checkout@v4
@@ -22,17 +22,14 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        pip install --upgrade -e .[test]
-        pip install flake8
+        pip install poetry
+        make dependencies
+
     - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      run: make lint
+
     - name: Run tests
-      run: |
-        pytest --cov=./ --cov-report=xml
+      run: make coverage
 
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v4

.readthedocs.yml

@@ -4,13 +4,10 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
-
+  jobs:
+     post_create_environment:
+       - python -m pip install poetry
+     post_install:
+       - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --only main,docs
 sphinx:
    configuration: docs/conf.py
-
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - doc

Makefile

@@ -1,13 +1,45 @@
+.PHONY: docs tests
 PYTHON_FILES = cassis tests
 
-test:
-	python -m pytest -m "not performance" tests/
+# Dependencies
+dependencies:
+	poetry install
 
+# Tests
+unit-tests:
+	poetry run py.test --cov=cassis --cov-branch --cov-fail-under=90 tests
+
+tests: unit-tests integ-tests
+
+coverage:
+	poetry run py.test --cov=cassis --cov-branch --cov-fail-under=90 --cov-report=xml:coverage.xml -m "not performance" tests
+
+# Static analysis/linting
 format:
-	black -l 120 cassis/
-	black -l 120 tests/
-	isort --profile black $(PYTHON_FILES) --multi-line=3 --trailing-comma --force-grid-wrap=0 --use-parentheses --line-width=120
+	poetry run ruff format $(PYTHON_FILES)
+
+lint:
+    # stop the build if there are Python syntax errors or undefined names
+	poetry run ruff check --select=E9,F63,F7,F82 --output-format=full $(PYTHON_FILES)
+    # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+    # flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+	poetry run ruff check --exit-zero $(PYTHON_FILES)
+
+# Docs
+docs:
+	cd docs && make html
+
+# Building and publishing
+build: unit-tests lint
+	poetry build
+
+publish: build
+	poetry publish
+
+# CI
 
+ci-publish:
+	poetry publish --build --username "${PYPI_USERNAME}" --password "${PYPI_PASSWORD}" --no-interaction
 
-html:
-	cd docs && make html
+ci-bump-version:
+	poetry run bump2version patch

README.rst

@@ -489,9 +489,8 @@ Release
 
 - Make sure all issues for the milestone are completed, otherwise move them to the next
 - Checkout the ``main`` branch
-- Bump the version in ``cassis/__version__.py`` to a stable one, e.g. ``__version__ = "0.6.0"``, commit and push, wait until the build completed. An example commit message would be ``No issue. Release 0.6.0``
+- Bump the version in ``pyproject.toml`` to a stable one, e.g. ``__version__ = "0.6.0"``, commit and push, wait until the build completed. An example commit message would be ``No issue. Release 0.6.0``
 - Create a tag for that version via e.g. ``git tag v0.6.0`` and push the tags via ``git push --tags``. Pushing a tag triggers the release to pypi
-- Bump the version in ``cassis/__version__.py`` to the next development version, e.g. ``0.7.0-dev``, commit and push that. An example commit message would be ``No issue. Bump version after release``
+- Bump the version in ``pyproject.toml`` to the next development version, e.g. ``0.7.0-dev``, commit and push that. An example commit message would be ``No issue. Bump version after release``
 - Once the build has completed and pypi accepted the new version, go to the Github release and write the changelog based on the issues in the respective milestone
 - Create a new milestone for the next version
-