ipa-python-kit 0.1.3.dev1

kit for python

pyproject-tmpl

features

1. pytest
2. pre-commit
3. darker for code format
4. ruff for lint
5. commitlint for commit message format
6. typer for cli
7. sqlmodel for database ORM
8. alembic for database migration

introduction

the project uses src-layout, includes sdk (for publish) and biz (for business logic). sdk is designed for publish and no need to rename, we use file/folder mapping mylib=src/sdk in pyproject.toml.

dev

before you start:

1. must run ./scripts/setup
2. just replace mylib with [the name you want] in the whole project
3. remember to uv pip install -e .[all] to make sure mylib is available in development.

unit test

uv run -m pytest

run cli

uv run main.py --help

release sdk

1. cp .pypirc.example .pypirc
2. replace your token in .pypirc
3. git tag vx.y.z
4. ./scripts/publish

build executable file

./scripts/build