pycmdcheck 0.1.0__tar.gz → 0.1.1__tar.gz

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/.github/workflows/ci.yml

@@ -17,9 +17,9 @@ jobs:
     name: Lint & type-check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v8.2.0
         with:
           # 3.10 matches [tool.mypy] python_version and installs tomli
           # (a conditional dependency) so mypy can resolve the tomllib fallback.
@@ -42,9 +42,9 @@ jobs:
       matrix:
         python-version: ["3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v8.2.0
         with:
           python-version: ${{ matrix.python-version }}
           enable-cache: true

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/.github/workflows/release.yml

@@ -13,9 +13,9 @@ jobs:
     name: Test & build distributions
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
       - name: Install uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v8.2.0
         with:
           python-version: "3.12"
           enable-cache: true
@@ -26,7 +26,7 @@ jobs:
       - name: Build sdist and wheel
         run: uv build
       - name: Upload distributions
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: dist
           path: dist/
@@ -44,9 +44,9 @@ jobs:
       id-token: write  # OIDC: required for PyPI Trusted Publishing (no token)
     steps:
       - name: Download distributions
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v8
         with:
           name: dist
           path: dist/
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@v1.14.0

pycmdcheck-0.1.1/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+
+All notable changes to pycmdcheck will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1] - 2026-06-25
+
+### Added
+
+- `--exit-zero` CLI flag: always exit `0` regardless of check results, so the
+  exit code reflects whether pycmdcheck ran rather than what it found. Intended
+  for CI/automation that parses the results (e.g. `--json`) itself.
+
+### Fixed
+
+- Project URLs now point to the actual repository
+  (`github.com/coatless-py-pkg/pycmdcheck`); the previously declared
+  `pycmdcheck/pycmdcheck` URLs referenced a repository that does not exist (404).
+- Installation instructions use `pip install pycmdcheck` now that the package is
+  published on PyPI.
+- Corrected inaccurate docstrings (the `metadata`/`tests`/`structure`/`typing`
+  Returns sections, the `check`/`run_checks` built-in-check lists, `get_profile`,
+  and `discover_checks`) and the illustrative API doctests that crashed under
+  `pytest --doctest-modules`.
+
+### Changed
+
+- Documentation and docstrings no longer hard-code the built-in check list;
+  they reference `pycmdcheck --list`, and a test keeps `ALL_CHECKS` in sync with
+  the registered entry points.
+- Updated GitHub Actions to current versions (`checkout` v7, `setup-uv` v8.2.0,
+  `upload-artifact` v7, `download-artifact` v8, `gh-action-pypi-publish` v1.14.0).
+
+## [0.1.0] - 2026-06-25
+
+First release of pycmdcheck on PyPI.
+
+### Added
+
+- Core `check()` function and `pycmdcheck` CLI, with Rich terminal output and
+  JSON output for CI integration.
+- Built-in checks: `metadata`, `structure`, `tests`, `linting`, `typing`,
+  `imports`, `license`, `docs`, `dependencies`, `build`, `formatting`,
+  `version`, `py_typed`, `community`, `ci`, `changelog`, `citation`,
+  `python_versions`, `urls`, `doctests`.
+- Profile system — `minimal`, `triage`, `default`, `pyopensci`, `strict` — with
+  `--profile` and `--list-profiles`. The `triage` profile runs only static,
+  no-install/no-network checks, intended for CI triage of arbitrary
+  (un-installed) repositories.
+- Configuration via `[tool.pycmdcheck]` in pyproject.toml, a plugin system via
+  entry points for custom checks, and parallel check execution.
+- Support for legacy Poetry projects (`[tool.poetry]` with no PEP 621
+  `[project]` table) across the metadata, version, python_versions, and
+  dependencies checks.
+- Recognition of PEP 420 namespace packages, single-file modules, and
+  native-extension build backends (maturin/scikit-build/setuptools-rust) in the
+  `structure` check.
+- `formatting` check auto-detects the configured formatter (ruff vs black) and
+  is skipped when none is configured.
+- GitHub Actions: CI (lint + type-check + pytest on 3.10–3.13) and a
+  tag-triggered PyPI release via Trusted Publishing (OIDC).
+- Public API: `CheckResult`, `CheckStatus`, `Report`, and the `BaseCheck`
+  abstract class for custom checks.
+
+The checks are intentionally lenient to avoid false positives on legitimate
+real-world packages (PEP 621 `dynamic` fields, dual-license filenames, RST
+READMEs, community files under `.github/`/`docs/`, dependency extras, and more).

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: pycmdcheck
-Version: 0.1.0
+Version: 0.1.1
 Summary: Python package quality checker inspired by R CMD check
-Project-URL: Homepage, https://github.com/pycmdcheck/pycmdcheck
-Project-URL: Repository, https://github.com/pycmdcheck/pycmdcheck
-Project-URL: Issues, https://github.com/pycmdcheck/pycmdcheck/issues
+Project-URL: Homepage, https://github.com/coatless-py-pkg/pycmdcheck
+Project-URL: Repository, https://github.com/coatless-py-pkg/pycmdcheck
+Project-URL: Issues, https://github.com/coatless-py-pkg/pycmdcheck/issues
 Author: pycmdcheck contributors
 License-Expression: MIT
 License-File: LICENSE
@@ -46,40 +46,30 @@ A Python package quality checker inspired by R's `R CMD check`.
 
 ## Installation
 
-> **Note:** pycmdcheck is not yet published to PyPI. Install it directly from
-> GitHub for now. Once it is released, `pip install pycmdcheck` will work too.
-
 ```bash
-pip install git+https://github.com/coatless-py-pkg/pycmdcheck
+pip install pycmdcheck
 ```
 
 Or with uv:
 
 ```bash
-uv pip install git+https://github.com/coatless-py-pkg/pycmdcheck
+uv add pycmdcheck
 ```
 
-To pin a specific branch, tag, or commit, append `@<ref>` to the URL — for
-example `git+https://github.com/coatless-py-pkg/pycmdcheck@main`.
-
 ### Optional dependencies
 
-pycmdcheck can use external tools for linting and type checking. Request the
-matching extra in the install command. For a GitHub install, the extra goes in
-the PEP 508 `pycmdcheck[extra] @ <url>` form:
-
 ```bash
 # For mypy type checking
-pip install "pycmdcheck[typing-mypy] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[typing-mypy]
 
 # For pyright type checking
-pip install "pycmdcheck[typing-pyright] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[typing-pyright]
 
 # For ruff linting
-pip install "pycmdcheck[linting] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[linting]
 
 # All optional dependencies
-pip install "pycmdcheck[all] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[all]
 ```
 
 ## Usage
@@ -204,9 +194,9 @@ Profiles bundle checks for common use cases:
 |---------|-------------|--------|
 | `minimal` | Quick sanity checks | metadata, structure, license |
 | `triage` | Static checks only — no install, external tools, or network (for CI triage of arbitrary repos) | All static checks (excludes tests, imports, dependencies, build, linting, typing, formatting, doctests, urls) |
-| `default` | Standard quality checks | All 13 core checks |
-| `pyopensci` | pyOpenSci onboarding | All 20 checks with stricter docs settings |
-| `strict` | Maximum strictness | All 20 checks with strict typing |
+| `default` | Standard quality checks | All original core checks |
+| `pyopensci` | pyOpenSci onboarding | All checks with stricter docs settings |
+| `strict` | Maximum strictness | All checks with strict typing |
 
 ```bash
 # Run pyOpenSci onboarding checks

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/README.md

@@ -4,40 +4,30 @@ A Python package quality checker inspired by R's `R CMD check`.
 
 ## Installation
 
-> **Note:** pycmdcheck is not yet published to PyPI. Install it directly from
-> GitHub for now. Once it is released, `pip install pycmdcheck` will work too.
-
 ```bash
-pip install git+https://github.com/coatless-py-pkg/pycmdcheck
+pip install pycmdcheck
 ```
 
 Or with uv:
 
 ```bash
-uv pip install git+https://github.com/coatless-py-pkg/pycmdcheck
+uv add pycmdcheck
 ```
 
-To pin a specific branch, tag, or commit, append `@<ref>` to the URL — for
-example `git+https://github.com/coatless-py-pkg/pycmdcheck@main`.
-
 ### Optional dependencies
 
-pycmdcheck can use external tools for linting and type checking. Request the
-matching extra in the install command. For a GitHub install, the extra goes in
-the PEP 508 `pycmdcheck[extra] @ <url>` form:
-
 ```bash
 # For mypy type checking
-pip install "pycmdcheck[typing-mypy] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[typing-mypy]
 
 # For pyright type checking
-pip install "pycmdcheck[typing-pyright] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[typing-pyright]
 
 # For ruff linting
-pip install "pycmdcheck[linting] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[linting]
 
 # All optional dependencies
-pip install "pycmdcheck[all] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[all]
 ```
 
 ## Usage
@@ -162,9 +152,9 @@ Profiles bundle checks for common use cases:
 |---------|-------------|--------|
 | `minimal` | Quick sanity checks | metadata, structure, license |
 | `triage` | Static checks only — no install, external tools, or network (for CI triage of arbitrary repos) | All static checks (excludes tests, imports, dependencies, build, linting, typing, formatting, doctests, urls) |
-| `default` | Standard quality checks | All 13 core checks |
-| `pyopensci` | pyOpenSci onboarding | All 20 checks with stricter docs settings |
-| `strict` | Maximum strictness | All 20 checks with strict typing |
+| `default` | Standard quality checks | All original core checks |
+| `pyopensci` | pyOpenSci onboarding | All checks with stricter docs settings |
+| `strict` | Maximum strictness | All checks with strict typing |
 
 ```bash
 # Run pyOpenSci onboarding checks

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/docs/_quarto.yml

@@ -21,7 +21,7 @@ website:
         href: changelog.qmd
     right:
       - icon: github
-        href: https://github.com/pycmdcheck/pycmdcheck
+        href: https://github.com/coatless-py-pkg/pycmdcheck
 
 format:
   html:

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/docs/cli.qmd

@@ -51,6 +51,19 @@ pycmdcheck --fail-on error --fail-on warning
 pycmdcheck --fail-on error --fail-on warning --fail-on note
 ```
 
+### `--exit-zero`
+
+Always exit `0` regardless of check results — report status only via the output
+(or `--json`). The exit code then reflects whether pycmdcheck *ran*, not what it
+*found*: `0` means it ran successfully, and a non-zero code means pycmdcheck
+itself could not run (e.g. a usage error). This is the recommended mode for CI
+that parses the results itself and should only treat tool failures as job
+failures.
+
+```bash
+pycmdcheck --json --exit-zero --profile triage
+```
+
 ### `--profile`
 
 Run a predefined set of checks. Available profiles:
@@ -59,9 +72,9 @@ Run a predefined set of checks. Available profiles:
 |---------|--------|
 | `minimal` | metadata, structure, license |
 | `triage` | static checks only — no install, external tools, or network (for CI triage of arbitrary repos) |
-| `default` | the 13 core checks |
-| `pyopensci` | all 20 checks, with stricter docs settings |
-| `strict` | all 20 checks at maximum strictness |
+| `default` | the original core checks |
+| `pyopensci` | all checks, with stricter docs settings |
+| `strict` | all checks at maximum strictness |
 
 ```bash
 # pyOpenSci onboarding checks
@@ -89,7 +102,7 @@ List all available checks and exit.
 pycmdcheck --list
 ```
 
-Output (20 checks):
+Output:
 ```
                            Available Checks
 ┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
@@ -168,7 +181,9 @@ pycmdcheck --no-parallel
 
 ### `-x, --fail-fast`
 
-Stop after the first check whose status matches `--fail-on`.
+Stop after the first check that returns an ERROR status. This is independent of
+`--fail-on` (which only affects the final exit code) — fail-fast always triggers
+on ERROR.
 
 ```bash
 pycmdcheck -x
@@ -203,9 +218,9 @@ pycmdcheck --help
 
 | Code | Meaning |
 |------|---------|
-| 0 | All checks passed (no status matching `--fail-on`) |
-| 1 | One or more checks failed (status matched `--fail-on`) |
-| 2 | Invalid usage (e.g., an unknown check name passed to `-c`/`--check`) |
+| 0 | All checks passed (no status matching `--fail-on`), or any result with `--exit-zero` |
+| 1 | One or more checks failed (status matched `--fail-on`); suppressed by `--exit-zero` |
+| 2 | Invalid usage (e.g., an unknown check name passed to `-c`/`--check`); **not** suppressed by `--exit-zero` |
 
 ## Examples
 

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/docs/configuration.qmd

@@ -12,7 +12,7 @@ pycmdcheck is configured via the `[tool.pycmdcheck]` section in your `pyproject.
 fail_on = ["error"]
 
 [tool.pycmdcheck.checks]
-# Enable/disable checks (all 20 checks are enabled by default; list only the
+# Enable/disable checks (every check is enabled by default; list only the
 # ones you want to turn off or configure).
 metadata = true
 structure = true

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/docs/getting-started.qmd

@@ -4,44 +4,34 @@ title: Getting Started
 
 ## Installation
 
-::: {.callout-note}
-pycmdcheck is not yet published to PyPI. Install it directly from GitHub for
-now. Once it is released, `pip install pycmdcheck` will work too.
-:::
-
 ### Using pip
 
 ```bash
-pip install git+https://github.com/coatless-py-pkg/pycmdcheck
+pip install pycmdcheck
 ```
 
 ### Using uv
 
 ```bash
-uv pip install git+https://github.com/coatless-py-pkg/pycmdcheck
+uv add pycmdcheck
 ```
 
-To pin a specific branch, tag, or commit, append `@<ref>` to the URL — for
-example `git+https://github.com/coatless-py-pkg/pycmdcheck@main`.
-
 ### Optional Dependencies
 
-pycmdcheck can use external tools for linting and type checking. Request the
-matching extra when installing. For a GitHub install, the extra goes in the
-PEP 508 `pycmdcheck[extra] @ <url>` form:
+pycmdcheck can use external tools for linting and type checking. Install the optional dependencies based on your needs:
 
 ```bash
 # For mypy type checking
-pip install "pycmdcheck[typing-mypy] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[typing-mypy]
 
 # For pyright type checking
-pip install "pycmdcheck[typing-pyright] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[typing-pyright]
 
 # For ruff linting
-pip install "pycmdcheck[linting] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[linting]
 
 # All optional dependencies
-pip install "pycmdcheck[all] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+pip install pycmdcheck[all]
 ```
 
 ## Your First Check
@@ -54,7 +44,7 @@ Navigate to your Python package directory and run:
 pycmdcheck
 ```
 
-You'll see output like (abbreviated — a default run executes all 20 checks):
+You'll see output like (abbreviated — a default run executes every enabled check):
 
 ```
 Checking package: /path/to/your/package
@@ -72,7 +62,7 @@ Checking package: /path/to/your/package
 │  ✓  │ typing          │ No type errors found        │
 │  ✓  │ version         │ Version 0.1.0 is consistent │
 │  ℹ  │ ci              │ No CI configuration found   │
-│  …  │ …               │ … (all 20 checks run)       │
+│  …  │ …               │ … (all enabled checks run)  │
 └─────┴─────────────────┴─────────────────────────────┘
 
 18 ok | 2 note
@@ -111,7 +101,8 @@ Each check returns one of five statuses:
 
 ## Built-in Checks
 
-pycmdcheck includes 20 built-in checks:
+pycmdcheck ships the following built-in checks (run `pycmdcheck --list` for the
+authoritative, up-to-date set):
 
 | Check | Description |
 |-------|-------------|

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/docs/index.qmd

@@ -52,19 +52,14 @@ else:
 
 ## Installation
 
-::: {.callout-note}
-pycmdcheck is not yet published to PyPI. Install it directly from GitHub for
-now. Once it is released, `pip install pycmdcheck` will work too.
-:::
-
 ```bash
-pip install git+https://github.com/coatless-py-pkg/pycmdcheck
+pip install pycmdcheck
 ```
 
 Or with uv:
 
 ```bash
-uv pip install git+https://github.com/coatless-py-pkg/pycmdcheck
+uv add pycmdcheck
 ```
 
 ## Next Steps

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pycmdcheck"
-version = "0.1.0"
+version = "0.1.1"
 description = "Python package quality checker inspired by R CMD check"
 readme = "README.md"
 license = "MIT"
@@ -67,9 +67,9 @@ urls = "pycmdcheck.checks.urls:URLsCheck"
 doctests = "pycmdcheck.checks.doctests:DoctestsCheck"
 
 [project.urls]
-Homepage = "https://github.com/pycmdcheck/pycmdcheck"
-Repository = "https://github.com/pycmdcheck/pycmdcheck"
-Issues = "https://github.com/pycmdcheck/pycmdcheck/issues"
+Homepage = "https://github.com/coatless-py-pkg/pycmdcheck"
+Repository = "https://github.com/coatless-py-pkg/pycmdcheck"
+Issues = "https://github.com/coatless-py-pkg/pycmdcheck/issues"
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/pycmdcheck"]

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/src/pycmdcheck/__init__.py

@@ -66,10 +66,9 @@ def check(
 
     Args:
         path: Path to the package directory. Defaults to current directory.
-        checks: List of check names to run. If None, runs all enabled checks
-            from configuration. Available checks: build, dependencies, docs,
-            formatting, imports, license, linting, metadata, py_typed,
-            structure, tests, typing, version.
+        checks: Names of checks to run. If None, runs all enabled checks from
+            configuration. The available check names are discovered dynamically
+            via entry points; run ``pycmdcheck --list`` to see the current set.
         skip: List of check names to skip, even if enabled in configuration.
         config: Pre-loaded configuration dictionary. If None, configuration
             is loaded from the package's pyproject.toml.
@@ -84,8 +83,8 @@ def check(
         Basic usage - check current directory:
 
         >>> from pycmdcheck import check  # doctest: +SKIP
-        >>> report = check(".")
-        >>> report.passed
+        >>> report = check(".")  # doctest: +SKIP
+        >>> report.passed  # doctest: +SKIP
         True
 
         Run only specific checks:

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/src/pycmdcheck/checks/metadata.py

@@ -65,8 +65,10 @@ class MetadataCheck(BaseCheck):
         Returns:
             A CheckResult with:
 
-            - OK status if all required and recommended fields present
-            - NOTE status if required fields present but some recommended missing
+            - OK status if all required, recommended, and extended (authors,
+              urls, classifiers) fields are present
+            - NOTE status if required fields are present but some recommended
+              or extended fields are missing
             - WARNING status if using legacy setup.py/setup.cfg
             - ERROR status if pyproject.toml is invalid or missing required fields
         """

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/src/pycmdcheck/checks/structure.py

@@ -73,7 +73,10 @@ class StructureCheck(BaseCheck):
         Returns:
             A CheckResult with:
 
-            - OK status if valid src or flat layout found
+            - OK status if a valid src, flat, single-module, or PEP 420
+              namespace layout is found
+            - NOTE status if src/ has no Python package but a native-extension
+              build backend (maturin/scikit-build/setuptools-rust) is declared
             - WARNING status if packages missing ``__init__.py``
             - ERROR status if no package or module found
         """

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/src/pycmdcheck/checks/tests.py

@@ -70,7 +70,8 @@ class TestsCheck(BaseCheck):
 
             - OK status if all tests pass
             - WARNING status if no tests found
-            - ERROR status if tests fail or runner not installed
+            - ERROR status if tests fail, time out, fail to launch, or an
+              unknown runner is configured
             - SKIPPED status if the test runner is not installed
         """
         runner = config.get("runner", "pytest")

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/src/pycmdcheck/checks/typing.py

@@ -74,6 +74,8 @@ class TypingCheck(BaseCheck):
             A CheckResult with:
 
             - OK status if no type errors found
+            - WARNING status if mypy cannot analyze the package due to a
+              configuration/layout error (mypy exit code 2)
             - ERROR status if type errors found or checker fails
             - SKIPPED status if the type checker is not installed
         """

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/src/pycmdcheck/cli.py

@@ -40,6 +40,16 @@ console = Console()
     default=["error"],
     help="Exit with non-zero code on these statuses. Default: error",
 )
+@click.option(
+    "--exit-zero",
+    "exit_zero",
+    is_flag=True,
+    help=(
+        "Always exit 0 regardless of check results (report status via output "
+        "or --json only). The exit code then reflects whether pycmdcheck ran, "
+        "not what it found — useful for CI that parses results itself."
+    ),
+)
 @click.option(
     "--list",
     "list_checks",
@@ -89,6 +99,7 @@ def main(
     check: tuple[str, ...],
     skip: tuple[str, ...],
     fail_on: tuple[str, ...],
+    exit_zero: bool,
     list_checks: bool,
     verbose: bool,
     json_output: bool,
@@ -197,8 +208,10 @@ def main(
     else:
         _output_rich(report, verbose)
 
-    # Determine exit code
-    if report.failed_on(list(fail_on)):
+    # Determine exit code. With --exit-zero, findings never change the exit
+    # code (the caller is expected to read the results), so a non-zero exit
+    # then reflects only that pycmdcheck itself could not run.
+    if report.failed_on(list(fail_on)) and not exit_zero:
         sys.exit(1)
 
 

{pycmdcheck-0.1.0 → pycmdcheck-0.1.1}/src/pycmdcheck/discovery.py

@@ -34,8 +34,8 @@ def discover_checks() -> dict[str, type["Check"]]:
     package's pyproject.toml, and third-party packages can register
     additional checks.
 
-    If a check fails to load (e.g., due to an import error), a
-    UserWarning is issued but discovery continues with other checks.
+    If a check fails to load (e.g., due to an import error), a warning is
+    logged (via ``logger.warning``) but discovery continues with other checks.
 
     Returns:
         A dictionary mapping check names (strings) to check classes.
@@ -43,20 +43,17 @@ def discover_checks() -> dict[str, type["Check"]]:
         pycmdcheck.checks.base.
 
     Examples:
-        Discover all available checks:
+        Discover all available checks (returns a name -> class mapping):
 
         >>> checks = discover_checks()
-        >>> "metadata" in checks
-        True
-        >>> "tests" in checks
+        >>> isinstance(checks, dict)
         True
 
-        Get a specific check class:
+        Get a specific check class (requires the package to be installed so its
+        entry points are registered):
 
-        >>> checks = discover_checks()
-        >>> MetadataCheck = checks["metadata"]
-        >>> instance = MetadataCheck()
-        >>> instance.name
+        >>> MetadataCheck = discover_checks()["metadata"]  # doctest: +SKIP
+        >>> MetadataCheck().name  # doctest: +SKIP
         'metadata'
     """
     checks: dict[str, type[Check]] = {}
@@ -100,10 +97,7 @@ def list_available_checks() -> list[tuple[str, str]]:
         List all checks for display:
 
         >>> checks = list_available_checks()
-        >>> len(checks) > 0
-        True
-        >>> name, description = checks[0]
-        >>> isinstance(name, str) and isinstance(description, str)
+        >>> isinstance(checks, list)
         True
 
         Display in CLI: