pyproject-doctor 0.1.0__tar.gz

pyproject_doctor-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Report a bug in pyproject-doctor
+title: '[Bug] '
+labels: bug
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior, including your pyproject.toml content.
+
+**Expected behavior**
+What you expected pyproject-doctor to report.
+
+**Actual behavior**
+What pyproject-doctor actually reported (include the full output).
+
+**Environment**
+- pyproject-doctor version:
+- Python version:
+- OS:

pyproject_doctor-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest a new check or improvement
+title: '[Feature] '
+labels: enhancement
+assignees: ''
+---
+
+**What check or feature are you requesting?**
+
+**What semantic mistake would this catch?**
+
+**Example pyproject.toml that should trigger the new check:**
+
+**What should the diagnostic message say?**

pyproject_doctor-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: pip install -e ".[dev]"
+      - run: ruff check .
+      - run: mypy src
+      - run: pytest -q

pyproject_doctor-0.1.0/.gitignore

@@ -0,0 +1,43 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+dist/
+*.egg-info/
+.eggs/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Type checking
+.mypy_cache/
+
+# Ruff
+.ruff_cache/
+
+# Distribution
+dist/
+uv.lock
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db

pyproject_doctor-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+- id: pyproject-doctor
+  name: pyproject-doctor
+  description: Validate pyproject.toml for semantic errors
+  entry: pyproject-doctor
+  language: python
+  files: ^pyproject\.toml$
+  pass_filenames: false

pyproject_doctor-0.1.0/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to pyproject-doctor will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-06-17
+
+### Added
+
+- Initial release of pyproject-doctor.
+- PEP 440 version validation (`version-invalid`).
+- PEP 508 dependency validation (`dep-invalid`) for `project.dependencies`, `project.optional-dependencies`, and `build-system.requires`.
+- Version constraint satisfiability checking (`constraint-unsatisfiable`): detects impossible version ranges.
+- File existence validation (`file-missing`) for readme, license, and entry-point module paths.
+- URL format validation (`url-invalid`) for `project.urls`.
+- Email format validation (`email-invalid`) for authors and maintainers.
+- Entry-point format validation (`entry-point-invalid`) for scripts, gui-scripts, and entry-points.
+- Trove classifier validation (`classifier-unknown`) via optional `trove-classifiers` dependency.
+- Text and JSON output formats.
+- Pre-commit hook support via `.pre-commit-hooks.yaml`.
+- CLI: `pyproject-doctor [PATH] [--format text|json]`.
+
+### Notes
+
+- PyPI release is pending. Install from source or GitHub for now.
+
+[0.1.0]: https://github.com/amaar-mc/pyproject-doctor/releases/tag/v0.1.0

pyproject_doctor-0.1.0/CLAUDE.md

@@ -0,0 +1,33 @@
+# CLAUDE.md
+
+## Project: pyproject-doctor
+
+Offline deep validator for pyproject.toml. Catches semantic mistakes other tools miss.
+
+## Key Design Decisions
+
+- Pure functions for all checks; CLI and file IO are thin shells.
+- No default parameter values anywhere; expose named variants if needed.
+- Strict mypy typing throughout.
+- `packaging` library for PEP 440 and PEP 508 validation only.
+- Optional `trove-classifiers` for classifier validation; gracefully skip if absent.
+- Satisfiability checker is custom (packaging has no is_satisfiable).
+- File existence checks only run when `src/` exists under root.
+
+## Adding Checks
+
+1. Add a pure function to `src/pyproject_doctor/checks/<module>.py`.
+2. Compose it in `src/pyproject_doctor/checks/__init__.py`.
+3. Write tests first.
+4. Stable diagnostic codes are kebab-case; never rename them.
+
+## Gates Before Committing
+
+```
+uv pip install -e ".[dev]"
+uv run pytest -q
+uv run ruff check .
+uv run mypy src
+uv build
+uv run --with twine twine check dist/*
+```

pyproject_doctor-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,29 @@
+# Code of Conduct
+
+## Our Pledge
+
+We pledge to make participation in this project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+
+Examples of unacceptable behavior:
+
+- Trolling, insulting, or derogatory comments
+- Public or private harassment
+- Publishing others' private information without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting the maintainers directly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

pyproject_doctor-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to pyproject-doctor
+
+Thank you for your interest in contributing!
+
+## Development Setup
+
+1. Clone the repository.
+2. Install in editable mode with dev dependencies:
+
+```bash
+uv pip install -e ".[dev]"
+```
+
+3. Run tests:
+
+```bash
+uv run pytest -q
+```
+
+4. Run linting:
+
+```bash
+uv run ruff check .
+uv run mypy src
+```
+
+## Adding a New Check
+
+1. Write a failing test first (`tests/test_<check>.py`).
+2. Add a pure function to the appropriate module under `src/pyproject_doctor/checks/`.
+3. Expose it via `check_pyproject` in `src/pyproject_doctor/checks/__init__.py`.
+4. Add test data files to `tests/data/` as needed.
+5. Update `docs/architecture.md` to describe the check.
+6. Update `CHANGELOG.md` under `[Unreleased]`.
+
+## Commit Style
+
+Commits use the `type(scope): description` format. For example:
+
+- `feat(checks): add Python version compatibility check`
+- `fix(deps): handle wildcard specifiers in satisfiability check`
+- `test(version): add test for post-release versions`
+
+## Code Style
+
+- Strict mypy typing required.
+- No default parameter values.
+- Pure functions for checks.
+- No em dashes in code, comments, or docs.

pyproject_doctor-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Amaar Chughtai
+
+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.

pyproject_doctor-0.1.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: pyproject-doctor
+Version: 0.1.0
+Summary: Offline deep validator for pyproject.toml: file existence, URL and email format, PEP 440 version and PEP 508 specifier validity, version-constraint satisfiability, and entry-point format.
+Project-URL: Homepage, https://github.com/amaar-mc/pyproject-doctor
+Project-URL: Repository, https://github.com/amaar-mc/pyproject-doctor
+Project-URL: Bug Tracker, https://github.com/amaar-mc/pyproject-doctor/issues
+Author-email: Amaar Chughtai <amaardevx@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Amaar Chughtai
+        
+        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.
+License-File: LICENSE
+Keywords: linter,packaging,pep508,pep621,pre-commit,pyproject,validator
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: packaging>=23.0
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Provides-Extra: classifiers
+Requires-Dist: trove-classifiers>=2023.1.1; extra == 'classifiers'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: trove-classifiers>=2023.1.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pyproject-doctor
+
+<p align="center">
+  <img src="assets/logo.png" alt="pyproject-doctor logo" width="160">
+</p>
+
+Offline deep validator for `pyproject.toml` that catches the semantic mistakes other tools miss.
+
+Most validators only check TOML syntax. pyproject-doctor goes further: it validates that your versions are PEP 440 compliant, your dependencies are PEP 508 compliant, your version constraints are actually satisfiable, your referenced files exist, your URLs are real URLs, your email addresses look right, and your entry-point references are correctly formatted.
+
+> **PyPI release pending.** Install from GitHub for now (see below).
+
+## What it checks
+
+| Code | Description |
+|------|-------------|
+| `version-invalid` | `project.version` is not a valid PEP 440 version |
+| `dep-invalid` | A dependency in `project.dependencies`, `project.optional-dependencies`, or `build-system.requires` is not a valid PEP 508 requirement |
+| `constraint-unsatisfiable` | A dependency's version specifiers form an impossible range (e.g. `>=2.0,<1.0`) |
+| `file-missing` | A file referenced by `project.readme`, `project.license`, or an entry-point module does not exist |
+| `url-invalid` | A value in `project.urls` is not a valid absolute URL |
+| `email-invalid` | An author or maintainer email address is malformed |
+| `entry-point-invalid` | A script or entry-point value is not in valid `module:attr` format |
+| `classifier-unknown` | A classifier in `project.classifiers` is not a known trove classifier (requires `pip install 'pyproject-doctor[classifiers]'`) |
+
+## Install
+
+```bash
+pip install git+https://github.com/amaar-mc/pyproject-doctor.git
+```
+
+Or with classifier validation:
+
+```bash
+pip install "git+https://github.com/amaar-mc/pyproject-doctor.git#egg=pyproject-doctor[classifiers]"
+```
+
+## Usage
+
+```bash
+# Validate pyproject.toml in the current directory
+pyproject-doctor
+
+# Validate a specific file
+pyproject-doctor /path/to/pyproject.toml
+
+# JSON output
+pyproject-doctor --format json
+```
+
+Exit code is 1 if any error-level diagnostic is found, 0 otherwise.
+
+## Pre-commit
+
+Add to `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/amaar-mc/pyproject-doctor
+    rev: v0.1.0
+    hooks:
+      - id: pyproject-doctor
+```
+
+## Example output
+
+```
+error project.version: version-invalid: 'not.a.version' is not a valid PEP 440 version
+error project.dependencies[0]: constraint-unsatisfiable: Dependency 'requests': constraint '>=3.0,<2.0' is unsatisfiable (lower bound 3.0 exceeds upper bound 2.0)
+error project.urls.Homepage: url-invalid: URL 'not-a-url' is not a valid absolute URL (must have scheme and host)
+```
+
+## License
+
+MIT. Copyright (c) 2026 Amaar Chughtai.

pyproject_doctor-0.1.0/README.md

@@ -0,0 +1,75 @@
+# pyproject-doctor
+
+<p align="center">
+  <img src="assets/logo.png" alt="pyproject-doctor logo" width="160">
+</p>
+
+Offline deep validator for `pyproject.toml` that catches the semantic mistakes other tools miss.
+
+Most validators only check TOML syntax. pyproject-doctor goes further: it validates that your versions are PEP 440 compliant, your dependencies are PEP 508 compliant, your version constraints are actually satisfiable, your referenced files exist, your URLs are real URLs, your email addresses look right, and your entry-point references are correctly formatted.
+
+> **PyPI release pending.** Install from GitHub for now (see below).
+
+## What it checks
+
+| Code | Description |
+|------|-------------|
+| `version-invalid` | `project.version` is not a valid PEP 440 version |
+| `dep-invalid` | A dependency in `project.dependencies`, `project.optional-dependencies`, or `build-system.requires` is not a valid PEP 508 requirement |
+| `constraint-unsatisfiable` | A dependency's version specifiers form an impossible range (e.g. `>=2.0,<1.0`) |
+| `file-missing` | A file referenced by `project.readme`, `project.license`, or an entry-point module does not exist |
+| `url-invalid` | A value in `project.urls` is not a valid absolute URL |
+| `email-invalid` | An author or maintainer email address is malformed |
+| `entry-point-invalid` | A script or entry-point value is not in valid `module:attr` format |
+| `classifier-unknown` | A classifier in `project.classifiers` is not a known trove classifier (requires `pip install 'pyproject-doctor[classifiers]'`) |
+
+## Install
+
+```bash
+pip install git+https://github.com/amaar-mc/pyproject-doctor.git
+```
+
+Or with classifier validation:
+
+```bash
+pip install "git+https://github.com/amaar-mc/pyproject-doctor.git#egg=pyproject-doctor[classifiers]"
+```
+
+## Usage
+
+```bash
+# Validate pyproject.toml in the current directory
+pyproject-doctor
+
+# Validate a specific file
+pyproject-doctor /path/to/pyproject.toml
+
+# JSON output
+pyproject-doctor --format json
+```
+
+Exit code is 1 if any error-level diagnostic is found, 0 otherwise.
+
+## Pre-commit
+
+Add to `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/amaar-mc/pyproject-doctor
+    rev: v0.1.0
+    hooks:
+      - id: pyproject-doctor
+```
+
+## Example output
+
+```
+error project.version: version-invalid: 'not.a.version' is not a valid PEP 440 version
+error project.dependencies[0]: constraint-unsatisfiable: Dependency 'requests': constraint '>=3.0,<2.0' is unsatisfiable (lower bound 3.0 exceeds upper bound 2.0)
+error project.urls.Homepage: url-invalid: URL 'not-a-url' is not a valid absolute URL (must have scheme and host)
+```
+
+## License
+
+MIT. Copyright (c) 2026 Amaar Chughtai.

pyproject_doctor-0.1.0/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported |
+|---------|-----------|
+| 0.1.x   | Yes       |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in pyproject-doctor, please report it by opening a GitHub issue with the label "security". For sensitive vulnerabilities, contact the maintainer directly at amaardevx@gmail.com.
+
+We will respond within 72 hours and aim to release a fix within 7 days of confirmed vulnerabilities.

pyproject_doctor-0.1.0/docs/architecture.md

@@ -0,0 +1,89 @@
+# Architecture
+
+## Overview
+
+pyproject-doctor is organized into a thin CLI shell over a pure-function core.
+
+```
+pyproject.toml file
+       |
+   parse.py (check_file)
+       |
+   tomllib / tomli
+       |
+   Mapping[str, Any]
+       |
+  checks/__init__.py (check_pyproject)
+       |
+  +----+----+----+----+----+----+----+
+  |    |    |    |    |    |    |    |
+ ver  dep  file url email  ep  cls
+```
+
+Each check is an independent pure function that takes `Mapping[str, Any]` (and optionally a `root: Path`) and returns `list[Diagnostic]`.
+
+## Diagnostic Model
+
+`Diagnostic` is a frozen dataclass with:
+- `level`: "error" | "warning" | "info"
+- `code`: stable kebab-case identifier (e.g., "version-invalid")
+- `key_path`: dotted location in the TOML (e.g., "project.dependencies[0]")
+- `message`: human-readable explanation
+
+## Checks
+
+### version (checks/version.py)
+
+Uses `packaging.version.Version` to validate PEP 440. Skips if "version" is in `project.dynamic`.
+
+### dependencies (checks/dependencies.py)
+
+Uses `packaging.requirements.Requirement` to validate PEP 508. Also runs satisfiability analysis.
+
+### Constraint Satisfiability Algorithm
+
+The satisfiability checker analyzes the specifiers in a `SpecifierSet` to detect impossible version ranges.
+
+**Algorithm:**
+
+1. Parse all specifiers from the set.
+2. Track an effective lower bound `(version, inclusive: bool)` and upper bound `(version, inclusive: bool)`.
+3. For each specifier operator:
+   - `==X`: adds X as both lower and upper bound (inclusive). Multiple different `==` pins are immediately unsatisfiable.
+   - `>=X`: update lower bound to max(current_lower, X) with inclusive=True.
+   - `>X`: update lower bound to max(current_lower, X) with inclusive=False (exclusive is tighter at same version).
+   - `<=X`: update upper bound to min(current_upper, X) with inclusive=True.
+   - `<X`: update upper bound to min(current_upper, X) with inclusive=False.
+   - `~=X.Y`: treated as `>=X.Y` for lower bound purposes.
+   - `!=X`: never contributes to unsatisfiability alone; excluded from analysis.
+   - `==X.*` (wildcard): skipped (too complex to bound tightly).
+4. After processing all specifiers, check:
+   - If `lower_ver > upper_ver`: unsatisfiable.
+   - If `lower_ver == upper_ver` and either endpoint is exclusive: unsatisfiable.
+   - Otherwise: satisfiable.
+
+**Examples:**
+- `>=2.0,<1.0`: lower=2.0(inc), upper=1.0(exc) => 2.0 > 1.0 => unsatisfiable
+- `>1.0,<=1.0`: lower=1.0(exc), upper=1.0(inc) => equal bounds, lower exclusive => unsatisfiable
+- `>=1.0,<=1.0`: lower=1.0(inc), upper=1.0(inc) => equal bounds, both inclusive => satisfiable (exactly 1.0)
+- `!=1.0,!=2.0`: no bounds derived => satisfiable
+
+### files (checks/files.py)
+
+Checks `project.readme`, `project.license.file`, `project.license-files` globs, and entry-point module paths. File checks are relative to the `root` directory. Entry-point module checks only run when `src/` exists under root, to avoid false positives on installed packages.
+
+### urls (checks/urls.py)
+
+Uses `urllib.parse.urlparse` to validate that each `project.urls` value has both a scheme and a netloc.
+
+### emails (checks/emails.py)
+
+Uses a pragmatic regex pattern to validate author/maintainer email addresses.
+
+### entry_points (checks/entry_points.py)
+
+Validates that each entry-point reference is in `module:attr` format, where both module and attr are valid dotted Python identifiers.
+
+### classifiers (checks/classifiers.py)
+
+Imports `trove_classifiers` at runtime. If not installed, emits an info diagnostic and skips. If installed, validates each classifier string against the known set.

pyproject_doctor-0.1.0/docs/charter.md

@@ -0,0 +1,28 @@
+# pyproject-doctor Charter
+
+## Mission
+
+pyproject-doctor catches semantic mistakes in pyproject.toml that other validators miss. It runs fully offline, with no network calls, and produces structured diagnostics that are easy to consume in CI or pre-commit hooks.
+
+## Scope
+
+pyproject-doctor validates:
+
+- PEP 440 version strings
+- PEP 508 dependency specifiers
+- Version constraint satisfiability
+- File existence (readme, license, entry-point modules)
+- URL format in project.urls
+- Email format in authors/maintainers
+- Entry-point format (module:attr)
+- Trove classifier validity (optional)
+
+pyproject-doctor does NOT:
+- Validate build backends beyond requiring valid PEP 508 in build-system.requires
+- Import or execute any project code
+- Make network calls
+- Replace a full build system
+
+## Stability
+
+Diagnostic codes (e.g., version-invalid, dep-invalid) are stable and will not change without a major version bump.

pyproject_doctor-0.1.0/docs/logo-prompt.md

@@ -0,0 +1,7 @@
+# Logo prompt
+
+Model: gpt-image-2. Format: 1024x1024, squircle (superellipse) corner mask.
+
+Flat vector app icon, full-bleed square composition, research-lab aesthetic: clean white and very pale blue background with a faint thin geometric grid, crisp black technical line work with a single medium-blue accent. Precise schematic scientific-figure look, centered, generous margins, balanced detail. Absolutely no text, no letters, no numerals, no robots, no neon, no glow, no 3D gloss, no photorealism. Keep the artwork to square edges with a flat background extending to all four corners (the corners will be masked into a squircle later).
+
+Subject: an offline validator that diagnoses a Python project configuration file. A stylized upright document or config card with a few thin horizontal rule lines suggesting key-value fields, overlaid with a clean stethoscope whose chestpiece rests on the document, and a small blue checkmark badge in one corner indicating a passed health check, with one tiny warning triangle among the lines suggesting a caught problem. Clean diagnostic schematic, no letters or numerals.

pyproject_doctor-0.1.0/examples/broken_pyproject.toml

@@ -0,0 +1,25 @@
+# This file intentionally contains errors to demonstrate pyproject-doctor
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "broken-example"
+version = "not.a.valid.version!!!"
+description = "Example of a broken pyproject.toml"
+dependencies = [
+    "requests>=3.0,<2.0",
+    "numpy not_valid_requirement",
+]
+authors = [
+    {name = "Bad Author", email = "not-an-email"},
+]
+classifiers = [
+    "This :: Is :: Not :: Real",
+]
+
+[project.urls]
+Homepage = "not-a-url"
+
+[project.scripts]
+my-tool = "no_colon_here"