This repository has been archived by the owner on Oct 9, 2024. It is now read-only.

add: readme details to project structure #77

	name: CI

	on: [push, pull_request]

	jobs:
	ci:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v3

	- name: Setup Python
	uses: actions/setup-python@v3
	with:
	python-version: 3.10.x

	- name: Install poetry
	run: \|
	python -m pip install poetry==1.7.0

	- name: Configure poetry
	run: \|
	python -m poetry config virtualenvs.in-project true

	- name: Cache the virtualenv
	uses: actions/cache@v3
	with:
	path: ./.venv
	key: ${{ runner.os }}-venv-${{ hashFiles('**/poetry.lock') }}

	- name: Install dependencies
	run: \|
	python -m poetry install --with dev

	- name: Format with black
	run: \|
	python -m poetry run black --diff --check $(git ls-files '*.py')

	- name: Static types check with mypy
	run: \|
	python -m poetry run mypy --strict $(git ls-files '*.py')

	- name: Ruff linter
	run: \|
	python -m poetry run ruff check $(git ls-files '*.py')
	python -m poetry run ruff check --select=I $(git ls-files '*.py')

	- name: Run tests
	run: \|
	python -m poetry run pytest -sxv

Provide feedback