py-import-checker 0.2.0

Fast, zero-dependency Python import health scanner

py-import-checker

Fast, zero-dependency Python import health scanner.

Recursively scan any Python project and instantly surface every broken or missing import — before your tests run, before CI fails, before runtime surprises you.

py-import-checker src/ --src src/

  py-import-checker  —  Python import health scanner

  Scanning  /home/user/myproject/src

──────────────────────────────────────────────────
  ✗  mypackage/broken_module.py
     ModuleNotFoundError: No module named 'nonexistent_lib'

──────────────────────────────────────────────────
✗ 1 broken import(s) found in 14 file(s) scanned.

Features

• Zero dependencies — uses only the Python standard library (importlib, pathlib, sys)
• src-layout aware — pass --src to add extra directories to sys.path
• Noise-free — only reports ImportError / ModuleNotFoundError; ignores runtime exceptions
• Auto-skips virtual environments (.venv, venv) and build artefacts
• CI-friendly — exits with code 1 on any broken import, 0 on success
• Self-checking — the CI pipeline scans itself with py-import-checker

Installation

pip install py-import-checker

Or install from source (editable):

git clone https://github.com/matthieugraziani/py-import-checker
cd py-import-checker
pip install -e .

Usage

Command line

# Scan the current directory
py-import-checker

# Scan a specific directory
py-import-checker path/to/project

# src-layout project (adds src/ to sys.path)
py-import-checker . --src src/

# Multiple extra paths
py-import-checker . --src src/ --src lib/

# Custom file glob
py-import-checker . --glob "app/**/*.py"

# Verbose output (show all files, not just errors)
py-import-checker . -v

Python API

from pathlib import Path
from py_import_checker.checker import check_directory

result = check_directory(
    root=Path("src/"),
    extra_paths=[Path("src/")],
)

if not result.success:
    for err in result.errors:
        print(f"{err.file}: {err.error_type}: {err.message}")

Pre-commit hook

Ajoutez ceci à votre fichier .pre-commit-config.yaml :

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/matthieugraziani/py-import-checker
    rev: v0.1.0
    hooks:
      - id: py-import-checker
        args: [--src, src/]

GitHub Actions

- name: Check imports
  run: |
    pip install py-import-checker
    py-import-checker . --src src/

How it works

py-import-checker utilise importlib.util.spec_from_file_location pour charger chaque fichier .py dans un namespace isolé. Seules les erreurs d’import sont capturées — tout le reste (erreurs runtime, variables manquantes, etc.) est ignoré.

Roadmap (suggestions)

• Mode --fix (suggestions d’imports)
• Support des packages namespace (init.py moins strict)
• Intégration VS Code / LSP
• Rapport HTML / JSON
• Détection de circular imports (optionnel)

---

Development

# Install with dev extras
pip install -e ".[dev]"

# Run tests
pytest

# Lint
ruff check src/ tests/

# Type-check
mypy src/

---

License - MIT

Auteur : Matthieu Graziani

### Améliorations apportées
- En-tête centré + badges propres
- Démo plus visible
- Sections plus aérées
- Roadmap ajoutée (pour montrer l’évolution)
- Meilleure lisibilité

### Actions prioritaires maintenant
1. **Publier sur PyPI** (version 0.1.0 ou 0.2.0) :
   ```bash
   hatch build
   hatch publish