pycode-doctor 0.1.0__tar.gz

pycode_doctor-0.1.0/.gitignore

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pycode_doctor-0.1.0/LICENSE

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

pycode_doctor-0.1.0/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.4
+Name: pycode-doctor
+Version: 0.1.0
+Summary: Fast, local-first CLI that gives your Python codebase a 0-100 health score
+Project-URL: Homepage, https://github.com/nabroleonx/python-doctor
+Project-URL: Documentation, https://nabroleonx.github.io/python-doctor/
+Project-URL: Repository, https://github.com/nabroleonx/python-doctor.git
+Project-URL: Issues, https://github.com/nabroleonx/python-doctor/issues
+Author: Nabeel S. Qureshi
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ai-agent,code-quality,health-check,linting,mcp,python,static-analysis
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: bandit>=1.8
+Requires-Dist: click>=8.1
+Requires-Dist: deptry>=0.14
+Requires-Dist: mypy>=1.13
+Requires-Dist: radon>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: ruff>=0.8.0
+Requires-Dist: vulture>=2.12
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Provides-Extra: full
+Requires-Dist: basedpyright>=1.38; extra == 'full'
+Requires-Dist: detect-secrets>=1.5; extra == 'full'
+Requires-Dist: httpx>=0.27; extra == 'full'
+Requires-Dist: mcp>=1.0; extra == 'full'
+Requires-Dist: typos>=1.44; extra == 'full'
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.0; extra == 'mcp'
+Provides-Extra: pyright
+Requires-Dist: basedpyright>=1.38; extra == 'pyright'
+Provides-Extra: quality-extra
+Requires-Dist: typos>=1.44; extra == 'quality-extra'
+Provides-Extra: secrets
+Requires-Dist: detect-secrets>=1.5; extra == 'secrets'
+Provides-Extra: vulns
+Requires-Dist: httpx>=0.27; extra == 'vulns'
+Description-Content-Type: text/markdown
+
+# python-doctor
+
+Fast, local-first Python code health checks with a single command.
+
+`python-doctor` combines Ruff, mypy, Bandit, Radon, Vulture, and deptry into a
+single 0-100 score with clear category breakdowns. It is designed to feel good
+with `uvx` first.
+
+## Quickstart
+
+Run it with no install step:
+
+```bash
+uvx python-doctor .
+```
+
+Use the latest published version explicitly:
+
+```bash
+uvx python-doctor@latest .
+```
+
+For deeper optional scans:
+
+```bash
+uvx --from 'python-doctor[full]' python-doctor .
+```
+
+Persistent install:
+
+```bash
+uv tool install python-doctor
+```
+
+## What The Default Scan Includes
+
+- Ruff for quality, security, complexity, and dead-code rule families
+- mypy for type checking
+- Bandit for security checks
+- Radon for complexity metrics
+- Vulture for dead code
+- deptry for dependency hygiene
+
+Optional extras add:
+
+- `dependency-vulns` for OSV-backed dependency vulnerability scanning
+- `detect-secrets` for secret scanning
+- `basedpyright` as an optional type backend
+- `typos` for spelling checks in source code
+- MCP support
+
+## Common Commands
+
+```bash
+# fast feedback
+python-doctor . --profile quick
+
+# full default scan
+python-doctor .
+
+# include optional analyzers if installed
+python-doctor . --profile full
+
+# only score output
+python-doctor . --score
+
+# machine-readable output
+python-doctor . --json
+
+# analyze only selected categories
+python-doctor . --only quality,types
+
+# skip categories
+python-doctor . --skip security,dead_code
+
+# safe Ruff autofix, then rescan
+python-doctor . --fix
+
+# show remediation text inline
+python-doctor . --show-fixes
+```
+
+## Why `src/python_doctor/`?
+
+The package is intentionally laid out as `src/python_doctor/`.
+
+- `python-doctor` is the distribution and CLI name
+- `python_doctor` is the Python import package name
+
+The `src/` layout prevents packaging and test mistakes where imports succeed
+from the checkout but fail from the built wheel.
+
+## Configuration
+
+Zero-config by default. Customize in `pyproject.toml`:
+
+```toml
+[tool.python-doctor]
+timeout = 60
+
+[tool.python-doctor.weights]
+quality = 25
+types = 20
+security = 20
+complexity = 15
+dead_code = 10
+dependencies = 10
+
+[tool.python-doctor.ignore]
+rules = ["S101"]
+files = ["tests/**", "migrations/**"]
+```
+
+See `docs/configuration.md` for the full reference.
+
+## MCP Server
+
+Expose health data to AI coding agents (Claude Code, Cursor, VS Code):
+
+```bash
+python-doctor install-mcp cursor
+```
+
+This registers python-doctor as an MCP server. Your AI agent can then call
+tools like `analyze_code`, `explain_rule`, `get_score`, `suggest_fixes`, and
+`check_diff`.
+
+See `docs/mcp-server.md` for details.
+
+## Plugins
+
+Extend python-doctor with custom analyzers via entry points:
+
+```toml
+[project.entry-points."python_doctor.analyzers"]
+my-analyzer = "my_package:MyAnalyzer"
+```
+
+See `docs/plugins.md` for the full guide.
+
+## Output Model
+
+The score covers six categories:
+
+- quality
+- type safety
+- security
+- complexity
+- dead code
+- dependencies
+
+V1 also reports coverage, so a score can tell you whether the scan was full,
+partial, or limited.
+
+## Docs
+
+Kept intentionally small:
+
+- `docs/configuration.md` -- weights, thresholds, ignore rules
+- `docs/scoring.md` -- scoring methodology
+- `docs/mcp-server.md` -- MCP server setup
+- `docs/plugins.md` -- custom analyzer development
+- `docs/development.md` -- contributing to python-doctor
+
+## Development
+
+```bash
+uv sync --all-extras
+uv run pytest
+uv run ruff check src tests
+uv run mypy src
+```
+
+See `docs/development.md` for the full guide.
+
+## License
+
+MIT

pycode_doctor-0.1.0/README.md

@@ -0,0 +1,178 @@
+# python-doctor
+
+Fast, local-first Python code health checks with a single command.
+
+`python-doctor` combines Ruff, mypy, Bandit, Radon, Vulture, and deptry into a
+single 0-100 score with clear category breakdowns. It is designed to feel good
+with `uvx` first.
+
+## Quickstart
+
+Run it with no install step:
+
+```bash
+uvx python-doctor .
+```
+
+Use the latest published version explicitly:
+
+```bash
+uvx python-doctor@latest .
+```
+
+For deeper optional scans:
+
+```bash
+uvx --from 'python-doctor[full]' python-doctor .
+```
+
+Persistent install:
+
+```bash
+uv tool install python-doctor
+```
+
+## What The Default Scan Includes
+
+- Ruff for quality, security, complexity, and dead-code rule families
+- mypy for type checking
+- Bandit for security checks
+- Radon for complexity metrics
+- Vulture for dead code
+- deptry for dependency hygiene
+
+Optional extras add:
+
+- `dependency-vulns` for OSV-backed dependency vulnerability scanning
+- `detect-secrets` for secret scanning
+- `basedpyright` as an optional type backend
+- `typos` for spelling checks in source code
+- MCP support
+
+## Common Commands
+
+```bash
+# fast feedback
+python-doctor . --profile quick
+
+# full default scan
+python-doctor .
+
+# include optional analyzers if installed
+python-doctor . --profile full
+
+# only score output
+python-doctor . --score
+
+# machine-readable output
+python-doctor . --json
+
+# analyze only selected categories
+python-doctor . --only quality,types
+
+# skip categories
+python-doctor . --skip security,dead_code
+
+# safe Ruff autofix, then rescan
+python-doctor . --fix
+
+# show remediation text inline
+python-doctor . --show-fixes
+```
+
+## Why `src/python_doctor/`?
+
+The package is intentionally laid out as `src/python_doctor/`.
+
+- `python-doctor` is the distribution and CLI name
+- `python_doctor` is the Python import package name
+
+The `src/` layout prevents packaging and test mistakes where imports succeed
+from the checkout but fail from the built wheel.
+
+## Configuration
+
+Zero-config by default. Customize in `pyproject.toml`:
+
+```toml
+[tool.python-doctor]
+timeout = 60
+
+[tool.python-doctor.weights]
+quality = 25
+types = 20
+security = 20
+complexity = 15
+dead_code = 10
+dependencies = 10
+
+[tool.python-doctor.ignore]
+rules = ["S101"]
+files = ["tests/**", "migrations/**"]
+```
+
+See `docs/configuration.md` for the full reference.
+
+## MCP Server
+
+Expose health data to AI coding agents (Claude Code, Cursor, VS Code):
+
+```bash
+python-doctor install-mcp cursor
+```
+
+This registers python-doctor as an MCP server. Your AI agent can then call
+tools like `analyze_code`, `explain_rule`, `get_score`, `suggest_fixes`, and
+`check_diff`.
+
+See `docs/mcp-server.md` for details.
+
+## Plugins
+
+Extend python-doctor with custom analyzers via entry points:
+
+```toml
+[project.entry-points."python_doctor.analyzers"]
+my-analyzer = "my_package:MyAnalyzer"
+```
+
+See `docs/plugins.md` for the full guide.
+
+## Output Model
+
+The score covers six categories:
+
+- quality
+- type safety
+- security
+- complexity
+- dead code
+- dependencies
+
+V1 also reports coverage, so a score can tell you whether the scan was full,
+partial, or limited.
+
+## Docs
+
+Kept intentionally small:
+
+- `docs/configuration.md` -- weights, thresholds, ignore rules
+- `docs/scoring.md` -- scoring methodology
+- `docs/mcp-server.md` -- MCP server setup
+- `docs/plugins.md` -- custom analyzer development
+- `docs/development.md` -- contributing to python-doctor
+
+## Development
+
+```bash
+uv sync --all-extras
+uv run pytest
+uv run ruff check src tests
+uv run mypy src
+```
+
+See `docs/development.md` for the full guide.
+
+## License
+
+MIT