Update package and workflows

.github/workflows/docs.yml

@@ -9,4 +9,4 @@ jobs:
  - uses: ammaraskar/sphinx-action@master
  with:
  docs-folder: "docs/"
- repo-token: "${{ secrets.GITHUB_TOKEN }}"
+ repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/python-lint.yml

@@ -0,0 +1,8 @@
+name: Linter
+on: [ push, pull_request ]
+jobs:
+ lint-ruff:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - uses: chartboost/ruff-action@v1

.github/workflows/python-package.yml

@@ -0,0 +1,25 @@
+name: Python package and test
+on: [push, pull_request]
+
+jobs:
+ test:
+
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v3
+ with:
+ python-version: ${{ matrix.python-version }}
+ - name: Install package and dependencies
+ run: |
+ python -m pip install --upgrade pip
+ python -m pip install .[test]
+ - name: Test with pytest
+ run: |
+ pytest

.github/workflows/python-publish.yml

@@ -0,0 +1,31 @@
+name: Upload Python Package
+
+on:
+ release:
+ types: [published]
+
+permissions:
+ contents: read
+
+jobs:
+ deploy:
+
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v3
+ with:
+ python-version: '3.x'
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install build
+ - name: Build package
+ run: python -m build
+ - name: Publish package
+ uses: pypa/gh-action-pypi-publish@release/v1
+ with:
+ user: __token__
+ password: ${{ secrets.pypi_password }}

.gitignore

@@ -90,4 +90,4 @@ ENV/
 .spyderproject
 
 # Rope project settings
-.ropeproject
+.ropeproject

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.5.0
+ hooks:
+ - id: trailing-whitespace
+ - id: end-of-file-fixer
+ exclude: "^.*drawio|.*.svg$"
+ - id: check-yaml
+ - id: check-added-large-files
+- repo: https://github.com/astral-sh/ruff-pre-commit
+ rev: v0.1.0
+ hooks:
+ - id: ruff
+- repo: https://github.com/psf/black-pre-commit-mirror
+ rev: 23.10.0
+ hooks:
+ - id: black

LICENSE.txt

@@ -19,4 +19,4 @@ Copyright (c) 2016 Jonathan de Bruin
  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- OTHER DEALINGS IN THE SOFTWARE.
+ OTHER DEALINGS IN THE SOFTWARE.