Contributor-oriented notes for the Python auralogger package.
- Source/publishing repo: Beever-Labs/auralogger-python
auralogger (Python): command-line tool for Auralogger: init, server-check, test-serverlog, and get-logs, plus the aura_log helper for Python apps.
├── LICENSE
├── pyproject.toml
├── README.md
- Python distribution name:
auralogger(pip install auralogger) - Node distribution name:
auralogger-cli(npm install auralogger-cli) - Both expose the CLI command
auralogger, but package-index names are intentionally different.
file-map.md: quick map of what each important module doesroutes.md: HTTP + WebSocket routes and where they are used in this package
Auth contract (match Node / hosted API): POST /api/{project_token}/proj_auth — token in path only. POST /api/{project_token}/logs — headers secret and user_secret both set to the user secret. Server ingest WebSocket — Authorization: Bearer <user_secret> on /{project_token}/create_log.
- Automated release workflow:
.github/workflows/python-publish.yml - Trigger: GitHub release publish for tags matching
python-v*(for example,python-v0.1.1) or manualworkflow_dispatch - Required secret:
PYPI_API_TOKEN - Before release: bump
versioninpyproject.tomland updateCHANGELOG.md - Manual fallback:
python -m pip install build twinepython -m buildtwine upload dist/*
user-docs/commands.md: end-user setup and command reference (keep in sync when behavior changes)docs/BDD/: behavior specsdocs/infra/: per-file infrastructure notes
- Change code under
auralogger/ - Update
dev-docs/(anduser-docs/when user-visible behavior changes) - Run tests or smoke checks as appropriate for your change