Skip to content

Development

Work happens in this monorepo: packages/entei-core and packages/entie are separate distributions with aligned versions.

Quick setup

pip install -e ./packages/entei-core -e "./packages/entie[dev]"
pytest

From the repository root, pytest runs with the coverage configuration in the root pyproject.toml (100% line coverage gate on library code).

Make targets

See the root README — Development for make test, make lint, make format, make coverage-html, and make build.

Canonical contributor guide

Commands, releases, design notes, and the documentation checklist live in CONTRIBUTING.md. Prefer that file as the single source of truth so CI and docs stay aligned.

Documentation site

Read the Docs builds from .readthedocs.yaml using the root mkdocs.yml. Connect the GitHub repository in the RTD dashboard (project slug entie matches the published URL).

Local build (same as CI):

pip install -e ./packages/entei-core -e "./packages/entie[docs]"
mkdocs build --strict

See docs/index.md for the table of contents of Markdown docs.