Switch to pyproject and address linters (#162)

* Update all CI tooling and switch to pyproject

* address lint issues found by new config

* fix typo

Author: marcelveldt

.github/workflows/publish-to-pypi.yml

@@ -1,31 +1,27 @@
-# This workflows will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
-
-name: Upload Python Package
+name: Publish releases to PyPI
 
 on:
   release:
     types: [published]
 
 jobs:
-  deploy:
-
+  build-and-publish:
+    name: Builds and publishes releases to PyPI
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v3.5.2
-    - name: Set up Python
-      uses: actions/[email protected]
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+      - uses: actions/checkout@v3.3.0
+      - name: Set up Python 3.10
+        uses: actions/[email protected]
+        with:
+          python-version: "3.10"
+      - name: Install build
+        run: >-
+          pip install build
+      - name: Build
+        run: >-
+          python3 -m build
+      - name: Publish release to PyPI
+        uses: pypa/[email protected]
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/test.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Test with Pre-commit
+name: Test
 
 on:
   push:
@@ -10,22 +10,43 @@ on:
     branches: [main]
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-latest
+    continue-on-error: true
+
+    steps:
+      - name: Check out code from GitHub
+        uses: actions/[email protected]
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip build setuptools
+          pip install . .[test]
+      - name: Lint/test with pre-commit
+        run: pre-commit run --all-files
+
+  test:
+    runs-on: ubuntu-latest
+    continue-on-error: true
     strategy:
+      fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10"]
+        python-version:
+          - "3.11"
 
     steps:
-      - uses: actions/[email protected]
+      - name: Check out code from GitHub
+        uses: actions/[email protected]
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/[email protected]
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements_dev.txt
-          pre-commit install-hooks
-      - name: Lint/test with pre-commit
-        run: pre-commit run --all-files
+          python -m pip install --upgrade pip build setuptools
+          pip install .[test]
+      - name: Pytest
+        run: pytest --durations 10 --cov-report term-missing --cov=aioslimproto --cov-report=xml tests/

.pre-commit-config.yaml

@@ -1,40 +1,47 @@
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: no-commit-to-branch
+        args:
+          - --branch=main
+      - id: debug-statements
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.0.272'
+    hooks:
+      - id: ruff
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
       - id: black
         args:
           - --safe
           - --quiet
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
     hooks:
-      - id: flake8
-        exclude: ^examples/
+      - id: codespell
+        args: []
+        exclude_types: [csv, json]
+        exclude: ^tests/fixtures/
         additional_dependencies:
-          - flake8-docstrings==1.6.0
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.10.1
-    hooks:
-      - id: isort
-        exclude: ^examples/
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.3.0
-    hooks:
-      - id: mypy
-        additional_dependencies: [types-all]
-        exclude: ^examples/
-  - repo: https://github.com/pycqa/pydocstyle
-    rev: 6.3.0
-    hooks:
-      - id: pydocstyle
-        exclude: ^examples/|^.venv/|^.vscode/
-  - repo: local
-    hooks:
-      - id: pylint
-        name: pylint
-        entry: script/run-in-env.sh pylint -j 0
-        language: script
-        types: [python]
-        args: ["-rn", "-sn", "--rcfile=pylintrc", "--fail-on=I"]
-        exclude: ^.venv/|^.vscode/|^tests/|example.py
+          - tomli
+  # TODO: enable pylint and mypy in follow up PR and fix the issues found
+  # - repo: local
+  #   hooks:
+  #     - id: pylint
+  #       name: pylint
+  #       entry: script/run-in-env.sh pylint -j 0
+  #       language: script
+  #       types: [python]
+  #       files: ^aioslimproto/.+\.py$
+
+  #     - id: mypy
+  #       name: mypy
+  #       entry: script/run-in-env.sh mypy
+  #       language: script
+  #       types: [python]
+  #       files: ^aioslimproto/.+\.py$

MANIFEST.in

@@ -1,6 +1,7 @@
-include README.md
-include requirements.txt
+include *.txt
+include *.ttf
+include README.rst
 include LICENSE
-include aioslimproto/font/
 graft aioslimproto
-recursive-exclude * *.py[co]
+recursive-exclude * *.py[co]
+recursive-exclude * *.DS_Store

README.md

@@ -8,7 +8,6 @@ aioslimproto
 
 SLIMProto implementation in async python allows you to control squeezebox players (and compatibles)
 
-Requires Python 3.8+ and uses asyncio.
+Requires Python 3.10+ and uses asyncio.
 
 For usage examples, see the examples folder.
-

aioslimproto.code-workspace

@@ -17,4 +17,4 @@
 		],
 		"compounds": []
 	}
-}
+}