ritebook 0.1.0

A minimal placeholder package for the future Ritebook project.

ritebook

Ritebook is currently a minimal Python package placeholder intended to reserve the package name on PyPI while the project is being designed.

Requirements

• Python 3.13 or newer
• uv for dependency management and command execution

Development setup

Install development dependencies:

uv sync --group dev

Run local quality checks:

uv run ruff format .
uv run ruff check .
uv run mypy .
uv run pytest

Build the package distributions:

uv build

Publishing

The GitHub Actions workflow in .github/workflows/ci-cd.yaml runs formatting, linting, type checking, tests, and package builds. It publishes to PyPI when a GitHub release is published.

Publishing uses PyPI Trusted Publishing through GitHub Actions OIDC. Before the first release, configure a trusted publisher for this repository in the PyPI project settings:

• Repository owner: ondrej-winter
• Repository name: ritebook
• Workflow filename: ci-cd.yaml
• Environment name: pypi

Architecture direction

Future business capabilities should be implemented as vertical feature slices under src/ritebook/features/, keeping domain, application ports/use cases, and adapters separated according to hexagonal architecture principles.