praxicraft-shared

Stateless Python utilities shared by Praxicraft backends (Practice, auth, notifications, billing, and future services). Products pin a PyPI version; no Django ORM, settings, or product business logic lives here.

Planning & milestones: Gamified-Application/docs/praxicraft-shared/README.md

Prerequisites

• Python 3.11+

Install (in a product)

Published on PyPI:

praxicraft-shared==0.7.1

pip install praxicraft-shared==0.7.1

Docker / CI need no GitHub token for this package — 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

Release

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

What’s in the package

org_client ships ahead of the auth A7 cutover: directory reads hit /api/v1/internal/orgs/…, and list helpers return [] while an endpoint is not deployed yet, so products can pin 0.7.0 before auth exposes the API.

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

Related

• praxicraft-auth
• praxicraft-notifications
• praxicraft-llm
• praxicraft-billing