codedoctor 0.1.1__tar.gz → 1.0.0__tar.gz

codedoctor-1.0.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @BigPattyOG

codedoctor-1.0.0/.github/dependabot.yml

@@ -0,0 +1,32 @@
+version: 2
+
+updates:
+  # Python dependencies (from pyproject.toml / requirements)
+  - package-ecosystem: "pip"
+    directory: "/"
+    target-branch: "main"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    rebase-strategy: "auto"
+    labels:
+      - "dependencies"
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"
+
+  # GitHub Actions used in .github/workflows/*.yml (including new workflows)
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: "main"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    rebase-strategy: "auto"
+    labels:
+      - "dependencies"
+    groups:
+      github-actions:
+        patterns:
+          - "*"

codedoctor-1.0.0/.github/pull_request_template.md

@@ -0,0 +1,8 @@
+## Summary
+<!-- What changed and why? -->
+
+## How to test
+<!-- Commands or steps -->
+
+## Checklist
+- [ ] PR title uses Conventional Commits (feat/fix/docs/chore/ci/etc.)

codedoctor-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: CI (Python 3.12)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+
+      - name: Ruff
+        run: ruff check .
+
+      - name: Black
+        run: black . --check
+
+      - name: MyPy
+        run: mypy . --pretty --show-error-codes
+
+      - name: Bandit (security)
+        run: bandit -r src -x tests
+
+      - name: Pytest
+        run: pytest -q
+
+      - name: Pip Audit (dependency vulnerabilities)
+        run: |
+          python -m pip install pip-audit
+          pip-audit

codedoctor-1.0.0/.github/workflows/codeql.yml

@@ -0,0 +1,36 @@
+name: CodeQL
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  schedule:
+    - cron: "23 3 * * 1" # Weekly (Mon)
+
+permissions:
+  contents: read
+
+jobs:
+  analyze:
+    name: Analyze (CodeQL)
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      security-events: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v4
+        with:
+          languages: python
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v4
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v4

codedoctor-1.0.0/.github/workflows/conventional-commits.yml

@@ -0,0 +1,29 @@
+name: Conventional PR Title
+
+on:
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  semantic-pr-title:
+    name: Check Conventional Commits PR Title
+    runs-on: ubuntu-latest
+    steps:
+      - name: Validate PR title follows Conventional Commits
+        uses: amannn/action-semantic-pull-request@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          types: |
+            feat
+            fix
+            docs
+            chore
+            refactor
+            test
+            ci
+            build
+          requireScope: false

codedoctor-1.0.0/.github/workflows/gitleaks.yml

@@ -0,0 +1,28 @@
+name: Gitleaks
+
+on:
+  pull_request:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  scan:
+    name: Secret scan (gitleaks)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Run gitleaks
+        uses: gitleaks/gitleaks-action@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITLEAKS_ENABLE_UPLOAD_ARTIFACT: "false"
+          GITLEAKS_ENABLE_SUMMARY: "true"

codedoctor-1.0.0/.github/workflows/release-please.yml

@@ -0,0 +1,20 @@
+name: Release Please
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Release Please
+        uses: googleapis/release-please-action@v4
+        with:
+          release-type: python
+          package-name: codedoctor

{codedoctor-0.1.1 → codedoctor-1.0.0}/.github/workflows/release.yml

@@ -14,10 +14,10 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@v5
         with:
           python-version: "3.12"
 
@@ -43,6 +43,7 @@ jobs:
     environment: pypi
     permissions:
       id-token: write
+
     steps:
       - name: Download dist artifacts
         uses: actions/download-artifact@v4
@@ -59,6 +60,7 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       contents: write
+
     steps:
       - name: Download dist artifacts
         uses: actions/download-artifact@v4
@@ -69,4 +71,4 @@ jobs:
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2
         with:
-          files: dist/*
+          files: dist/*

{codedoctor-0.1.1 → codedoctor-1.0.0}/.gitignore

@@ -4,4 +4,6 @@
 .pytest_cache/
 .codedoctor
 src/codedoctor/__pycache__/
-tests/__pycache__/
+tests/__pycache__/
+
+poetry.lock

codedoctor-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.0
+    hooks:
+      - id: ruff
+        args: ["--fix"]
+
+  - repo: https://github.com/psf/black
+    rev: 26.1.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.18.4
+    hooks:
+      - id: gitleaks

codedoctor-1.0.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## [1.0.0](https://github.com/BigPattyOG/CodeDoctor/compare/v0.2.0...v1.0.0) (2026-02-23)
+
+
+### ⚠ BREAKING CHANGES
+
+* Update to CodeDoctor and how it functions ([#16](https://github.com/BigPattyOG/CodeDoctor/issues/16))
+
+### Features
+
+* Update to CodeDoctor and how it functions ([#16](https://github.com/BigPattyOG/CodeDoctor/issues/16)) ([e41c3e8](https://github.com/BigPattyOG/CodeDoctor/commit/e41c3e894984b671508411d608bfdedfbf628acd))

{codedoctor-0.1.1 → codedoctor-1.0.0}/LICENSE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

codedoctor-1.0.0/PKG-INFO

@@ -0,0 +1,267 @@
+Metadata-Version: 2.4
+Name: codedoctor
+Version: 1.0.0
+Summary: Beginner-friendly codebase doctor: lint, format, type-check, security and tests.
+Author-email: Patrick Faint <pattymayo3@icloud.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: bandit>=1.7
+Requires-Dist: black>=24.0
+Requires-Dist: mypy>=1.8
+Requires-Dist: pytest>=8
+Requires-Dist: rich>=13.7
+Requires-Dist: ruff>=0.9
+Provides-Extra: dev
+Requires-Dist: bandit>=1.7.0; extra == 'dev'
+Requires-Dist: black>=24.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.7.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: rich>=13.7; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# CodeDoctor
+
+**CodeDoctor** is a beginner-friendly Python CLI that runs common quality checks
+(linting, formatting, type checking, security scanning, and tests) against **any**
+Python repository or folder you point it at, and produces a readable report.
+
+It’s designed to be simple to run, easy to understand, and safe by default.
+
+---
+
+## Requirements
+
+- Python **3.12+**
+- (Recommended) `git` available on PATH for best `.gitignore` support
+
+---
+
+## Install
+
+From PyPI:
+
+```bash
+python -m pip install codedoctor
+```
+
+Verify:
+
+```bash
+codedoctor --help
+codedoctor scan --help
+```
+
+---
+
+## Setup (required)
+
+Before running scans, initialize CodeDoctor once:
+
+```bash
+codedoctor setup
+```
+
+This creates a small config file in your user profile (JSON) that stores default
+behavior (e.g., whether to respect `.gitignore`, default report directory, etc.).
+
+### CI / no-config environments
+
+If you’re running in CI or you don’t want CodeDoctor to create a config file,
+you can bypass the setup requirement with:
+
+```bash
+codedoctor scan . --assume-defaults
+```
+
+---
+
+## Quick Start
+
+Scan the current folder:
+
+```bash
+codedoctor scan .
+```
+
+Scan a different path:
+
+```bash
+codedoctor scan /path/to/repo
+```
+
+On Windows:
+
+```powershell
+codedoctor scan C:\path\to\repo
+```
+
+Apply safe auto-fixes + formatting:
+
+```bash
+codedoctor scan . --fix
+```
+
+Skip tests:
+
+```bash
+codedoctor scan . --skip-tests
+```
+
+---
+
+## Commands
+
+### `codedoctor scan`
+
+```bash
+codedoctor scan [PATH] [--fix] [--skip-tests] [--report-dir DIR] [--no-gitignore] \
+  [--no-update-check] [--assume-defaults]
+```
+
+#### Options
+
+- `PATH`
+  Repository/folder to scan (default: `.`)
+
+- `--fix`
+  Apply safe auto-fixes (Ruff `--fix`) and format with Black.
+
+- `--skip-tests`
+  Skip running `pytest`.
+
+- `--report-dir DIR`
+  Directory (relative to the repo) to store reports. If omitted, uses the value
+  from your CodeDoctor config.
+
+- `--no-gitignore`
+  Disable best-effort `.gitignore` handling (useful for debugging).
+
+- `--no-update-check`
+  Disable the non-blocking “update available” notice during scans.
+
+- `--assume-defaults`
+  Allow scanning without running `codedoctor setup` (useful for CI).
+
+---
+
+### `codedoctor setup`
+
+```bash
+codedoctor setup [--force]
+```
+
+Creates or updates the user config file.
+
+- `--force` overwrites an existing config file.
+
+---
+
+### `codedoctor update`
+
+```bash
+codedoctor update [--yes]
+```
+
+Checks PyPI for the latest version and offers to upgrade CodeDoctor.
+
+- `--yes` updates without prompting.
+
+> Note: if CodeDoctor was installed into a locked or managed Python environment,
+> `codedoctor update` may fail due to permissions. In that case, update using
+> your environment’s normal package management approach (venv, pipx, etc.).
+
+---
+
+## What gets run during a scan
+
+CodeDoctor invokes the following tools (when installed/available):
+
+- `ruff check .` (and optionally `ruff check . --fix`)
+- `black . --check` (and optionally `black .`)
+- `mypy .`
+- `bandit -r .`
+- `pytest -q` (unless `--skip-tests`)
+
+CodeDoctor runs tools in the target repo by setting `cwd` to the repo path.
+
+---
+
+## Reports
+
+Reports are written under the repository (default `.codedoctor/`):
+
+- `report-latest.txt` — newest scan
+- `report-prev.txt` — previous scan (rotated)
+- `report-YYYYMMDD-HHMMSS.txt` — timestamped snapshot
+
+---
+
+## `.gitignore` behavior (best effort)
+
+Different tools treat ignore rules differently:
+
+- **Ruff** and **Black** already respect `.gitignore` in typical setups.
+- **MyPy** and **Bandit** do not consistently honor `.gitignore` the same way.
+
+To provide consistent behavior, CodeDoctor will **attempt** to use git’s ignore
+information when scanning a git repository by running:
+
+```bash
+git ls-files -ci --exclude-standard
+```
+
+Those ignored paths are then excluded from MyPy/Bandit runs.
+
+If any of the following are true:
+- the target folder is not a git repo
+- `git` is not installed
+- the git command fails
+
+…CodeDoctor falls back to excluding common junk directories like `.venv`, `.git`,
+caches, `build/`, and `dist/`.
+
+---
+
+## Exit Codes
+
+CodeDoctor returns an exit code that matches the overall result:
+
+- `0` — all checks passed
+- `1` — warnings (non-fatal issues)
+- `2` — failures (one or more checks failed)
+
+Missing tools are treated as failures for that check (return code `127`) so the
+report remains explicit and beginner-friendly.
+
+---
+
+## Development
+
+Clone and install editable:
+
+```bash
+git clone https://github.com/BigPattyOG/CodeDoctor.git
+cd CodeDoctor
+python -m pip install -e .
+```
+
+Run setup:
+
+```bash
+codedoctor setup
+```
+
+Run a scan:
+
+```bash
+codedoctor scan .
+```
+
+---
+
+## License
+
+MIT License. See `LICENSE`.