Skip to content

🛠️ Development

Working on jwtlib itself.

📂 Repository layout

Path Purpose
jwtlib/ The library package (app, introspection, models, repository, security, utils, exceptions)
jwtlib/*.pyi Type stubs published alongside the implementations
tests/ Auth-flow tests (register → login → verify → logout)
docs/lib/ Generated library reference (docforge, flat layout)
docs/mcp/ Machine-readable bundle served by the MCP server
docs/wiki/ This hand-written wiki

🔧 Setup

1
2
python -m venv .venv
.venv/Scripts/pip install -e ".[dev]"

🧪 Tests

1
.venv/Scripts/python -m pytest

The suite drives the full async auth flow: registration, login, duplicate handling, session lookup, logout, and introspection.

✅ Quality gates

The CI quality gate runs, matching the Drone pipeline:

1
2
3
4
.venv/Scripts/black --check .
.venv/Scripts/ruff check .
.venv/Scripts/mypy
.venv/Scripts/python -m pytest

📝 Building documentation (docforge)

The site is generated by docforge and served per kind under site/{kind}:

1
2
3
4
doc-forge build \
  --mkdocs --mcp --wiki \
  --module-is-source --module jwtlib \
  --site-name "JWT Authentication Library"
  • --module-is-source renders the flat docs/lib/ layout (no nesting under jwtlib/), matching docforge.nav.yml and docs/mkdocs.lib.yml.
  • --mcp regenerates the structured bundle in docs/mcp/.
  • --wiki builds this wiki.

Preview locally:

1
2
3
doc-forge serve --lib
doc-forge serve --wiki
doc-forge serve --mcp

🔒 Security checklist

  • Never log passwords, tokens, or hash material.
  • Keep new flows pure: models in models/, token logic in security.py, orchestration in app.py.
  • Add a regression test for every auth behavior change.