pycmdcheck 0.1.0__py3-none-any.whl

pycmdcheck-0.1.0.dist-info/METADATA

@@ -0,0 +1,346 @@
+Metadata-Version: 2.4
+Name: pycmdcheck
+Version: 0.1.0
+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
+Author: pycmdcheck contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: check,lint,package,quality,test
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: click>=8.0
+Requires-Dist: packaging>=21.0
+Requires-Dist: rich>=13.0
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Provides-Extra: all
+Requires-Dist: mypy>=1.0; extra == 'all'
+Requires-Dist: pyright>=1.1; extra == 'all'
+Requires-Dist: ruff>=0.1; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: quartodoc>=0.7; extra == 'docs'
+Provides-Extra: linting
+Requires-Dist: ruff>=0.1; extra == 'linting'
+Provides-Extra: typing-mypy
+Requires-Dist: mypy>=1.0; extra == 'typing-mypy'
+Provides-Extra: typing-pyright
+Requires-Dist: pyright>=1.1; extra == 'typing-pyright'
+Description-Content-Type: text/markdown
+
+# pycmdcheck
+
+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
+```
+
+Or with uv:
+
+```bash
+uv pip install git+https://github.com/coatless-py-pkg/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"
+
+# For pyright type checking
+pip install "pycmdcheck[typing-pyright] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+
+# For ruff linting
+pip install "pycmdcheck[linting] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+
+# All optional dependencies
+pip install "pycmdcheck[all] @ git+https://github.com/coatless-py-pkg/pycmdcheck"
+```
+
+## Usage
+
+### Command Line
+
+```bash
+# Check current directory
+pycmdcheck
+
+# Check a specific directory
+pycmdcheck /path/to/package
+
+# Run only specific checks
+pycmdcheck -c metadata -c tests
+
+# Skip specific checks
+pycmdcheck -s typing -s linting
+
+# Fail on warnings too
+pycmdcheck --fail-on error --fail-on warning
+
+# List available checks
+pycmdcheck --list
+
+# JSON output
+pycmdcheck --json
+
+# Stop after first error (fail fast)
+pycmdcheck -x
+pycmdcheck --fail-fast
+
+# Verbose output with details
+pycmdcheck -v
+
+# Use a check profile
+pycmdcheck --profile pyopensci
+pycmdcheck --profile minimal
+pycmdcheck --profile strict
+
+# List available profiles
+pycmdcheck --list-profiles
+```
+
+### With uv
+
+```bash
+uv run pycmdcheck
+uv run pycmdcheck -c tests -c linting
+```
+
+### Python API
+
+```python
+from pycmdcheck import check, CheckStatus
+
+# Check current directory
+report = check(".")
+
+# Check specific directory
+report = check("/path/to/package")
+
+# Run only specific checks
+report = check(".", checks=["metadata", "tests"])
+
+# Skip specific checks
+report = check(".", skip=["linting", "typing"])
+
+# Check results
+if report.passed:
+    print("All checks passed!")
+else:
+    for result in report.results:
+        print(f"{result.status}: {result.name} - {result.message}")
+
+# Get counts by status
+counts = report.count_by_status()
+print(f"OK: {counts[CheckStatus.OK]}, Errors: {counts[CheckStatus.ERROR]}")
+
+# JSON output
+import json
+print(json.dumps(report.to_dict(), indent=2))
+```
+
+## Built-in Checks
+
+### Core checks
+
+| Check | Description |
+|-------|-------------|
+| `build` | Verifies the package builds successfully (wheel/sdist) |
+| `dependencies` | Audits declared vs. actual imports, warns on unbounded versions |
+| `docs` | Checks for README (content sections, word count) and docstrings |
+| `formatting` | Checks code formatting (ruff format/black) |
+| `imports` | Validates all imports can be resolved |
+| `license` | Checks for LICENSE file and OSI-approved license validation |
+| `linting` | Runs ruff, flake8, or pylint |
+| `metadata` | Validates pyproject.toml fields (required, recommended, extended) |
+| `py_typed` | Checks for PEP 561 py.typed marker |
+| `structure` | Checks package directory structure (src or flat layout) |
+| `tests` | Runs pytest or unittest and reports results |
+| `typing` | Runs mypy or pyright type checker |
+| `version` | Verifies version consistency between pyproject.toml and code |
+
+### pyOpenSci / community checks
+
+| Check | Description |
+|-------|-------------|
+| `changelog` | Checks for CHANGELOG, NEWS, or HISTORY file |
+| `ci` | Checks for CI configuration (GitHub Actions, CircleCI, etc.) |
+| `citation` | Checks for CITATION.cff or CITATION.bib file |
+| `community` | Checks for CONTRIBUTING.md and CODE_OF_CONDUCT.md |
+| `doctests` | Runs doctests via pytest --doctest-modules |
+| `python_versions` | Checks requires-python excludes EOL Python versions |
+| `urls` | Validates project URLs in metadata are reachable |
+
+## Profiles
+
+Profiles bundle checks for common use cases:
+
+| Profile | Description | Checks |
+|---------|-------------|--------|
+| `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 |
+
+```bash
+# Run pyOpenSci onboarding checks
+pycmdcheck --profile pyopensci
+
+# Static-only triage (safe to run on an un-installed repo in CI)
+pycmdcheck --profile triage
+
+# Quick check before committing
+pycmdcheck --profile minimal
+```
+
+Profiles can be combined with `--skip` to exclude specific checks:
+
+```bash
+pycmdcheck --profile pyopensci -s urls -s doctests
+```
+
+## Configuration
+
+Configure pycmdcheck in your `pyproject.toml`:
+
+```toml
+[tool.pycmdcheck]
+# Fail on these statuses (default: ["error"])
+fail_on = ["error", "warning"]
+
+[tool.pycmdcheck.checks]
+# Enable/disable checks with boolean
+metadata = true
+structure = true
+imports = true
+license = true
+
+# Configure checks with options
+tests = { enabled = true, runner = "pytest" }
+linting = { enabled = true, tool = "ruff" }
+typing = { enabled = true, tool = "mypy", strict = false }
+# formatting "tool" defaults to "auto": detects ruff vs black from
+# [tool.ruff]/ruff.toml or [tool.black]; skips if neither is configured.
+formatting = { enabled = true, tool = "auto" }
+docs = { enabled = true, require_readme = true, check_docstrings = false, check_readme_sections = false }
+
+# New checks (disabled by default in "default" profile)
+community = true
+ci = true
+changelog = true
+citation = true
+python_versions = true
+urls = { enabled = true, timeout = 10 }
+doctests = true
+```
+
+### Linting tools
+
+Supported linting tools:
+- `ruff` (default, recommended)
+- `flake8`
+- `pylint`
+
+```toml
+[tool.pycmdcheck.checks.linting]
+tool = "ruff"
+args = ["--select=E,F,W"]
+```
+
+### Build options
+
+```toml
+[tool.pycmdcheck.checks.build]
+timeout = 300  # seconds (default: 120)
+args = ["--wheel"]
+```
+
+### Type checking tools
+
+Supported type checkers:
+- `mypy` (default)
+- `pyright`
+
+```toml
+[tool.pycmdcheck.checks.typing]
+tool = "pyright"
+strict = true
+```
+
+## Custom Checks
+
+Create custom checks by implementing the `Check` protocol:
+
+```python
+from pathlib import Path
+from typing import Any
+from pycmdcheck.checks.base import BaseCheck
+from pycmdcheck.results import CheckResult, CheckStatus
+
+class MyCustomCheck(BaseCheck):
+    name = "my_custom_check"
+    description = "My custom quality check"
+
+    def run(self, package_path: Path, config: dict[str, Any]) -> CheckResult:
+        # Your check logic here
+        issues = []  # ... populate with any issues found
+        if not issues:
+            return CheckResult(
+                name=self.name,
+                status=CheckStatus.OK,
+                message="All good!",
+            )
+        return CheckResult(
+            name=self.name,
+            status=CheckStatus.ERROR,
+            message="Something is wrong",
+            details=issues,
+        )
+```
+
+Register your check via entry points in `pyproject.toml`:
+
+```toml
+[project.entry-points."pycmdcheck.checks"]
+my_custom_check = "my_package.checks:MyCustomCheck"
+```
+
+## Check Statuses
+
+| Status | Symbol | Description |
+|--------|--------|-------------|
+| OK | ✓ | Check passed |
+| NOTE | ℹ | Minor observation, not a problem |
+| WARNING | ⚠ | Potential issue, should be reviewed |
+| ERROR | ✗ | Check failed |
+| SKIPPED | ○ | Check was skipped (e.g., tool not installed) |
+
+## License
+
+MIT

pycmdcheck-0.1.0.dist-info/RECORD

@@ -0,0 +1,41 @@
+pycmdcheck/__init__.py,sha256=GfesM3divwEOCvmtigML3PnKzmEV7VHsm7eS6F5hcMo,2954
+pycmdcheck/__main__.py,sha256=iPl7C-a99WAWaNX-eBAC_39XVZ_j_N-PkEyG9r0OWZ0,116
+pycmdcheck/ast_cache.py,sha256=W0pE-VE29086ZQ3-vzBdTVc-lLcu_LNP4hsl8YbedWI,1156
+pycmdcheck/cli.py,sha256=SBOmg0xK3lptElIkFscgdC3oKB6t2veSctsCqfPpcjw,8148
+pycmdcheck/config.py,sha256=3nRRV2fouo-TqbGDJmmkzaK5HUa-GaBT1vlGNwSVNUw,6166
+pycmdcheck/constants.py,sha256=Y9v1KlK7I9k3ggow4A22qTXYbpQOs8AnPZqidmB_VD4,674
+pycmdcheck/discovery.py,sha256=vtcxEO_NZrODNHAuy0ZyP7bnBA3xCO-iSqT93UrsQwI,3977
+pycmdcheck/package_layout.py,sha256=JlpX2SzzqJN3ZtkIBREFrfoZAHWX67Uju9PjiyF8lSg,8129
+pycmdcheck/profiles.py,sha256=kZBcYOvGoWYWzrI_qqPgIubTC4ANS_PHnFrvA-M6GgI,4337
+pycmdcheck/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pycmdcheck/pyproject_reader.py,sha256=bY4uQgzEABzC388tXVhnL3AJQCLGxj2R3gE642GmBvk,7649
+pycmdcheck/results.py,sha256=m1gP3PRhJ7A_AAWlxtLZFBFdt7q1TyShOpWzV_A0HMw,9732
+pycmdcheck/runner.py,sha256=u3okr3wiaPwuMvEiJOGgGkSZIFCNjVw9Uv7qX8y0h7U,7397
+pycmdcheck/subprocess_runner.py,sha256=A5P8s12ZRAmWh-ptJDVJvgQXh6GRMrjmTla-MU-QzcI,5076
+pycmdcheck/checks/__init__.py,sha256=DHT-oNFohsEa-fy8zf51PvRgKziqmInplAoalL0x_sk,38
+pycmdcheck/checks/base.py,sha256=h6Tx5YS01CX28qEL5xPuscLdtnfITyxBXDSTT9YEV8I,4853
+pycmdcheck/checks/build.py,sha256=4WBPejmgAIfp5ZQ46nPFgyTKCamfApcPxuv-7WGRLnA,3717
+pycmdcheck/checks/changelog.py,sha256=Hrng6R3VqsMRvTGzXsbvVd8hYIeGOM5SQkE9g8Ds36M,3226
+pycmdcheck/checks/ci.py,sha256=l8-rTUDKMcgGb5utjI1Sj0qc_UqGnYg45kqQU3vBKQ4,2906
+pycmdcheck/checks/citation.py,sha256=1W3a_SzRD-xzycZCPq_mfXtgYQZx5NRl_hoH6F9oQhU,3232
+pycmdcheck/checks/community.py,sha256=NV5M7RQqce-FnqHKq2xIisF3DbmuycKtyJFxzChRaq4,3412
+pycmdcheck/checks/dependencies.py,sha256=iV6X8hy1z8tLf5w5EjfPqEgo26jv-1FuxZ3-2cz-fqA,11578
+pycmdcheck/checks/docs.py,sha256=I_aGFKVOfdWeFtsChDS82kYBsdn1POn2I1EUvLrhWvo,11016
+pycmdcheck/checks/doctests.py,sha256=AhFnFujuKBrgfJ4ur_jZque0SoTDeMDCvnjKgGtw-Gk,4282
+pycmdcheck/checks/formatting.py,sha256=xrmr5SE6zqQK-Q0kqChE2rjf8m0ok4vlKZpfN14ihTM,7116
+pycmdcheck/checks/imports.py,sha256=5I_ddDbtRiDZFWvHpKe9BFQWFe0vaXe85S2Osol7Qa0,8296
+pycmdcheck/checks/license.py,sha256=m8T9sg17e1czgh5HWnbDEh3HnCGDpJsztUNicykL4f0,10746
+pycmdcheck/checks/linting.py,sha256=V2Y6GY7LGgAf2ITjRTXW8ifEm6p5s8jAgUC5rLtJy60,10510
+pycmdcheck/checks/metadata.py,sha256=hCZjUw21QjeijC3nUtlWyXX9xQrITx7sSeH7hIaAm1M,8920
+pycmdcheck/checks/py_typed.py,sha256=I1tNZVUCkYNBXBnqeQos8KLRMGqTlPhlE9xxNAwaAlA,7370
+pycmdcheck/checks/python_versions.py,sha256=tJJ-EM3VU3AwpdCFP3_RGy_zDOIdcGumYxLJT155TeA,7426
+pycmdcheck/checks/structure.py,sha256=HaGnlUaSPW94ulQuMvfmt3l7LqoriVW7ZUMIoxZfjDc,9884
+pycmdcheck/checks/tests.py,sha256=301WbzCyLt2uDF6B_J3KP9TFYckgZVX14EC8VnIBqP4,7726
+pycmdcheck/checks/typing.py,sha256=NWJxQ6uQdVnNMl9x3IEcUxeAGJM7DJwk1zEUTtDo_z0,9127
+pycmdcheck/checks/urls.py,sha256=kxBJDNP3-y3FF56J53xO7yWFO_cJxDhFv-xKw5PjcW4,4216
+pycmdcheck/checks/version.py,sha256=3ds9Y17gnCQpTdRsRhagHn8lwZ8Fymx8sGndahZ5jMo,7123
+pycmdcheck-0.1.0.dist-info/METADATA,sha256=Om3gWBYjSS4WqTwEc2_gSq7lkEYTj872jLiGigjUZA0,9685
+pycmdcheck-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+pycmdcheck-0.1.0.dist-info/entry_points.txt,sha256=kXqVitvlcY4DXx8F4o4sX83gJUUiVpZW196UOq5WHkE,1080
+pycmdcheck-0.1.0.dist-info/licenses/LICENSE,sha256=3-OoXjfqaCFy4LasY_7hVLS0qDX0-qGDzqS9mgijaBU,1080
+pycmdcheck-0.1.0.dist-info/RECORD,,

pycmdcheck-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

pycmdcheck-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,24 @@
+[console_scripts]
+pycmdcheck = pycmdcheck.cli:main
+
+[pycmdcheck.checks]
+build = pycmdcheck.checks.build:BuildCheck
+changelog = pycmdcheck.checks.changelog:ChangelogCheck
+ci = pycmdcheck.checks.ci:CICheck
+citation = pycmdcheck.checks.citation:CitationCheck
+community = pycmdcheck.checks.community:CommunityCheck
+dependencies = pycmdcheck.checks.dependencies:DependenciesCheck
+docs = pycmdcheck.checks.docs:DocsCheck
+doctests = pycmdcheck.checks.doctests:DoctestsCheck
+formatting = pycmdcheck.checks.formatting:FormattingCheck
+imports = pycmdcheck.checks.imports:ImportsCheck
+license = pycmdcheck.checks.license:LicenseCheck
+linting = pycmdcheck.checks.linting:LintingCheck
+metadata = pycmdcheck.checks.metadata:MetadataCheck
+py_typed = pycmdcheck.checks.py_typed:PyTypedCheck
+python_versions = pycmdcheck.checks.python_versions:PythonVersionsCheck
+structure = pycmdcheck.checks.structure:StructureCheck
+tests = pycmdcheck.checks.tests:TestsCheck
+typing = pycmdcheck.checks.typing:TypingCheck
+urls = pycmdcheck.checks.urls:URLsCheck
+version = pycmdcheck.checks.version:VersionCheck

pycmdcheck-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 pycmdcheck contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.