Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Doorcheck

See what a Home Assistant integration can do before you let it in.

v0.1 core milestone. The Python core is available for development. Local-folder and explicit commit/tag GitHub integration scans are available in the current source. The Home Assistant integration and dashboard-card scanning are still being built. The HA development preview provides read-only inventory, explicit static scans with saved results and framework tests; it does not raise alerts.

Doorcheck will scan Home Assistant custom integrations and dashboard cards, report what each one can do (the programs it runs, the hosts it contacts, the files it touches) and what changed between versions, and check your own setup for common exposures. It reports observations with evidence. It never declares anything safe: a scan that finds nothing means these checks found nothing, not that the code is safe, and anything a check couldn't cover is listed rather than skipped.

Doorcheck is not affiliated with Home Assistant or the Open Home Foundation.

What this milestone includes

This is an early library interface. A capability is an observation of source, not proof of runtime behavior. Dependency snapshots cover direct packages, not Home Assistant's full constrained installation. External tools have bounded execution and output; they are not sandboxed from the filesystem or network.

Scan an integration

From a checkout with Python 3.13.2 or newer and uv 0.13.4 or newer:

uv sync --locked
uv run doorcheck scan /path/to/integration
uv run doorcheck scan /path/to/integration --json
uv run doorcheck scan --repo OWNER/REPO --commit FULL_SHA
uv run doorcheck scan --repo OWNER/REPO --tag TAG

The command runs the source capability reader and one Python file-read rule. Add --semgrep-rule /path/to/trusted-rules.yaml to also run an already-installed, pinned Semgrep with explicit local rules. Dependency advisory checks are not run. See the CLI guide for coverage, SARIF and exit codes.

Try the Python core

Use Python 3.13.2 or newer on Linux or macOS. From a checkout:

uv sync --locked
uv run python
from pathlib import Path
from doorcheck.capabilities import scan
from doorcheck.messages import render, render_capability
from doorcheck.text import display_safe

result = scan(Path("/path/to/integration"))
for capability in result.capabilities:
    print(
        render_capability(capability),
        display_safe(capability.location.path),
        capability.location.line,
    )
for problem in result.problems:
    print(render(problem.key, problem.params))

The capability reader does not import or execute the scanned Python. Problem keys expose coverage gaps; the shared English catalog provides explanations for capabilities, findings and scan problems. External scanners are separate executables, not installed by this example.

Install

Version 0.1.0a1 is the first pre-release. Install the pre-release describes the HACS steps and the PyPI package. The integration checks daily for withdrawn versions and shows them in Repairs; you can turn this off.

Supported versions

The Home Assistant integration supports Home Assistant 2025.11 and newer, which means Python 3.13.2 or newer. It installs the scanning engine from PyPI, pinned to an exact version.

Development

# Use uv 0.13.4 or newer.
uv sync --locked
uv run pytest          # tests, with coverage
uv run ruff check .    # lint; `uv run ruff format .` to format
uv run mypy            # types
uv run lint-imports    # layer contracts
uv run mutmut run      # mutation tests; `uv run mutmut browse` to see survivors

CONTRIBUTING.md has the rest, including what a pull request needs. Localization describes locale coverage, offline freshness checks, and the bounded DeepL refresh workflow.

Maintenance

Doorcheck has one maintainer. If it goes quiet for more than 60 days with no word, treat it as unmaintained: don't rely on its results for new releases of anything, and expect no security fixes. Results it publishes will carry an expiry date, so they go stale on their own rather than looking current.

Security

Please report vulnerabilities in Doorcheck privately; see SECURITY.md. How Doorcheck handles problems it finds in other people's projects is in DISCLOSURE.md.

License

Apache-2.0

The initial Home Assistant path rule traces catch-all route values to file reads in explicitly unauthenticated views. It has a deliberately limited flow model; see its measured catches and blind spots before using its results.

HTTP request observations distinguish recognized Python HTTP calls from host-name mentions. They record an initial static URL authority when one is known and leave runtime destinations unresolved. They carry no severity and do not establish that network traffic occurred.

Metadata

Release files for doorcheck 0.1.0a1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for doorcheck 0.1.0a1
File Size Uploaded Provenance Actions
doorcheck-0.1.0a1.tar.gz 226.4 kB With provenance Details for doorcheck-0.1.0a1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for doorcheck 0.1.0a1
File Interpreter ABI Platform Actions
doorcheck-0.1.0a1-py3-none-any.whl Python 3 none any Details for doorcheck-0.1.0a1-py3-none-any.whl

Total release size: 474.1 kB

Release files / doorcheck-0.1.0a1.tar.gz

Download URL doorcheck-0.1.0a1.tar.gz
Size 226.4 kB
Tags Source
SHA-256 checksum
How to use checksums
0587cdf5d172abb4b27ec9319564c8d4380b049698ca95ffcbc532c72f8a40d5
BLAKE2b-256 checksum
How to use checksums
49f6029a58ec1ae2749b61fc0ea5f8adea406fb0cd3b07ebb7dd71ff9651e59c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 7, 2026.

Transparency log

Release files / doorcheck-0.1.0a1-py3-none-any.whl

Download URL doorcheck-0.1.0a1-py3-none-any.whl
Size 247.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d176ba0978d36f838a36a78730c316c9f029491eeffc21be4af5be9386d4defa
BLAKE2b-256 checksum
How to use checksums
67c5c6811827d3f4c3f781b07b1d945ca16935738eb8ab09d1518e23ab803fff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 7, 2026.

Transparency log

Security for doorcheck 0.1.0a1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for doorcheck-0.1.0a1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 7, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page