✨ first rudementary API documentation (#9) #34

	name: Python package

	on:
	push:
	branches: [main]
	pull_request:
	branches: [main]
	release:
	types: [published]

	jobs:
	format:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- uses: psf/black@stable
	lint:
	name: Lint with ruff
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- uses: actions/setup-python@v5
	with:
	python-version: "3.11"
	- name: Install ruff
	run: \|
	pip install ruff
	- name: Lint with ruff
	run: \|
	ruff check .
	test:
	name: Test
	runs-on: ubuntu-latest
	strategy:
	matrix:
	python-version: ["3.9", "3.10", "3.11", "3.12"]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	cache: 'pip' # caching pip dependencies
	cache-dependency-path: '**/pyproject.toml'
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install pytest
	pip install -e .
	# - name: Run tests
	# run: python -m pytest tests


	publish:
	name: Publish package
	if: startsWith(github.ref, 'refs/tags')
	permissions:
	id-token: write
	needs:
	- test
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v4

	- uses: actions/setup-python@v5
	with:
	python-version: "3.11"
	- name: Install twine and build
	run: python -m pip install --upgrade twine build
	- name: Build
	run: python -m build
	- name: Publish package distributions to PyPI
	uses: pypa/gh-action-pypi-publish@release/v1

Provide feedback