Development Setup

Prerequisites

• Python 3.10 or later
• uv (Python package manager)

Clone and Install

git clone https://github.com/gregorbaer/xaitimesynth.git
cd xaitimesynth

Install all dependencies (runtime + dev + test + docs + notebooks):

make setup

This runs uv sync --all-extras and sets up pre-commit hooks, nbstripout, and nbdime.

Common Commands

# Run tests
make test

# Run tests with coverage
make test-cov

# Lint
make lint

# Auto-format
make format

# Serve docs locally (localhost:8000)
make docs-serve

# Build docs
make docs-build

# Build package (wheel + sdist)
make build

Releasing a New Package Version

1. Update __version__ in xaitimesynth/__init__.py (single source of truth; pyproject.toml reads it automatically via hatchling)
2. Update version in CITATION.cff
3. Add a new section to CHANGELOG.md
4. Create a PR and merge into main
5. Tag the merge commit: git tag vX.Y.Z && git push --tags
6. Create a GitHub release from the tag (this triggers CI to build and publish to PyPI)

Project Structure

xaitimesynth/
├── xaitimesynth/      # Main package source
├── tests/             # Test suite
├── docs/              # Documentation source
├── notebooks/         # Example Jupyter notebooks
├── scripts/           # Utility scripts
├── pyproject.toml     # Package configuration
└── Makefile           # Development commands