feat: comprehensive codebase improvements and documentation #12

	name: CD / Release

	on:
	push:
	tags:
	- 'v*'

	jobs:
	build-n-publish:
	name: Build and publish Python 🐍 distributions 📦 to PyPI
	runs-on: ubuntu-latest
	permissions:
	contents: write # Required to create a release and upload assets
	steps:
	- uses: actions/checkout@v4

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.10"

	- name: Install build dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install build twine

	- name: Build binary wheel and source tarball
	run: python -m build

	- name: Publish distribution 📦 to PyPI
	uses: pypa/gh-action-pypi-publish@release/v1
	with:
	password: ${{ secrets.PYPI_API_TOKEN }}

	- name: Create GitHub Release
	uses: softprops/action-gh-release@v2
	with:
	files: dist/*
	generate_release_notes: true
	env:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Navigation Menu