praxicraft-shared

Stateless Python utilities shared by Praxicraft backends (Practice, auth, notifications, billing, support, Tutor, LLM clients). Products pin a PyPI version. No Django ORM, settings, or product business logic lives here.

Contents

1. About
2. Install in a product
3. Local development
4. What’s in the package
5. Release
6. Docs and deeper integrations

About

Hard rules:

1. Stateless — no Django models, ORM, Celery, or package-owned Redis singletons
2. No django.conf.settings — callers inject URLs and keys
3. No product logic (XP, Assess scoring, Tutor mastery)
4. Semver via git tags + PyPI — breaking JWT/auth contracts = major bump

Planning history: Practice shared docs.

Install in a product

Published on PyPI:

pip install praxicraft-shared==0.8.1

Docker / CI need no GitHub token — public index only.

Local editable (sibling checkout):

pip install -e ~/Desktop/praxicraft-shared

Local development

cd ~/Desktop/praxicraft-shared
pip install -e ".[dev]"
ruff check src tests
pytest

What’s in the package

Release

1. Bump version in pyproject.toml and __version__ in src/praxicraft_shared/__init__.py.
2. Merge to main.
3. Tag vX.Y.Z and push the tag (triggers Publish), or Actions → Publish → Run workflow with that existing tag.
4. GitHub Actions publishes to PyPI via Trusted Publishing and creates a GitHub Release.

Pushing main alone runs CI only — it does not publish to PyPI until a v* tag exists.

Docs and deeper integrations