Canon — spec-driven development platform

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for gernerventures from gravatar.com gernerventures

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: BUSL-1.1
    SPDX License Expression
  • Requires: Python >=3.12
  • Provides-Extra: cloud , dev , server
Classifiers
Report project as malware

Project description

Canon

Spec-driven development, automated.

Canon is an AI-native documentation platform. Write structured specs in markdown, and AI agents handle PR reviews, ticket sync, and code verification — keeping product, engineering, and business aligned.

This is the private monorepo. The open-source repo is at canonhq/canon.

Features

  • Spec-Aware PR Reviews — Analyzes PRs against relevant specs, identifies which acceptance criteria are addressed, flags gaps
  • Bidirectional Ticket Sync — Spec sections sync to Jira, Linear, or GitHub Issues in both directions
  • Code-Aware Verification — AI verifies that acceptance criteria are actually implemented, not just that tickets were closed
  • Coverage Dashboard — Track spec completion across your org by repo, team, and status
  • CLI & MCP Server — Plan, verify, status, sync, search, and dashboard commands with rich terminal output. MCP server for AI coding agents.
  • Claude Code Plugin — Spec-aware skills for spec-driven development workflows

Quick Start

Install the GitHub App on your organization:

Install Canon

Or use the CLI:

pip install canonhq
canon setup
canon status
canon dashboard

Documentation

Development

With Devbox (recommended)

Devbox provides a reproducible environment with all tools:

curl -fsSL https://get.jetify.com/devbox | bash   # one-time install
devbox shell                                        # enter environment
devbox run test                                     # run tests
devbox run lint                                     # lint + format check
devbox run dev                                      # start dev server

Without Devbox

uv sync --extra dev --extra cloud
uv run pytest
uv run ruff check
uv run uvicorn canon.main:app --reload

See docs/contributing/testing.md for the full testing guide (integration tests, scenario tests, contract recording).

License

BSL 1.1 — converts to Apache 2.0 after four years per release.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for gernerventures from gravatar.com gernerventures

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: BUSL-1.1
    SPDX License Expression
  • Requires: Python >=3.12
  • Provides-Extra: cloud , dev , server
Classifiers

Release history Release notifications | RSS feed

1.77.0

1.76.0

1.75.0

1.74.0

1.73.0

1.72.0

1.71.1

1.71.0

1.70.5

1.70.4

1.70.3

1.70.2

This version

1.70.1

1.70.0

1.69.0

1.68.1

1.68.0

1.67.3

1.67.2

1.67.1

1.67.0

1.66.1

1.66.0

1.65.0

1.64.0

1.63.0

1.62.3

1.62.2

1.62.1

1.62.0

1.61.0

1.60.2

1.60.1

1.60.0

1.59.1

1.59.0

1.58.0

1.57.2

1.57.1

1.57.0

1.56.0

1.55.1

1.55.0

1.54.3

1.54.2

1.54.1

1.54.0

1.53.0

1.52.6

1.52.4

1.52.3

1.52.2

1.52.1

1.52.0

1.51.1

1.51.0

1.50.1

1.50.0

1.49.1

1.49.0

1.48.0

1.47.0

1.46.4

1.46.3

1.46.2

1.46.1

1.46.0

1.45.2

1.45.1

1.45.0

1.44.1

1.44.0

1.43.1

1.43.0

1.42.0

1.41.1

1.41.0

1.40.0

1.39.0

1.38.0

1.37.0

1.36.0

1.35.0

1.34.0

1.33.1

1.33.0

1.32.2

1.32.1

1.32.0

1.31.5

1.31.4

1.31.3

1.31.2

1.31.1

1.31.0

1.30.2

1.30.1

1.30.0

1.29.2

1.29.1

1.29.0

1.28.0

1.27.0

1.26.5

1.26.4

1.26.3

1.26.2

1.26.1

1.26.0

1.25.0

1.24.0

1.23.0

1.22.0

1.21.0

1.20.6

1.20.5

1.20.4

1.20.1

1.20.0

1.19.2

1.19.1

1.19.0

1.18.7

1.18.6

1.18.5

1.18.4

0.0.1.dev0 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

canonhq-1.70.1.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

canonhq-1.70.1-py3-none-any.whl (582.5 kB view details)

Uploaded Python 3

File details

Details for the file canonhq-1.70.1.tar.gz.

File metadata

  • Download URL: canonhq-1.70.1.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for canonhq-1.70.1.tar.gz
Algorithm Hash digest
SHA256 399e0eed67503e20bc588035d6ecc215df2a1ebf688a556380c1a7068de22589
MD5 be399ef92cb750171af49c8d3427b7f0
BLAKE2b-256 1f94192f2380a598a452d5246396412eb2e9f739b6ccea01afe204199b4c9c2f

See more details on using hashes here.

Provenance

The following attestation bundles were made for canonhq-1.70.1.tar.gz:

Publisher: publish.yml on canonhq/canon-private

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file canonhq-1.70.1-py3-none-any.whl.

File metadata

  • Download URL: canonhq-1.70.1-py3-none-any.whl
  • Upload date:
  • Size: 582.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for canonhq-1.70.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8cf997d506aae27ae694d0bca89dfa9d61ecc4c2265a3a5ccc2aeb016687cc85
MD5 44baf864afdc1b4c6568d83d43e70051
BLAKE2b-256 9c6532010ef42a1d277d1552119d7fbe14dae399f382cb6cb5ed20f3fe8ba88d

See more details on using hashes here.

Provenance

The following attestation bundles were made for canonhq-1.70.1-py3-none-any.whl:

Publisher: publish.yml on canonhq/canon-private

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page