add simple CLI and user guide #24

	# This workflow will install Python dependencies, run tests and lint with a single version of Python
	# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

	name: Test with mypy and pytest

	on:
	push:
	branches: [ "main" ]
	pull_request:
	branches: [ "main" ]

	permissions:
	contents: read

	jobs:
	test:
	runs-on: ${{ matrix.os }}
	strategy:
	matrix:
	os: [ubuntu-latest]
	python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python 3.10
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
	if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
	- name: Lint with mypy
	run: \|
	mypy .
	- name: Test with pytest
	run: \|
	pytest

Provide feedback