Scan locally. Understand the report for free.

1. Run the Pydantic scanner

Python 3.10+ and pip are required. Replace path/to/your/repo with your local checkout. The public scanner does not edit files or send your code anywhere.

python -m venv .zipper-venv
# Windows PowerShell:
.\.zipper-venv\Scripts\Activate.ps1
# macOS / Linux: source .zipper-venv/bin/activate
python -m pip install "https://github.com/zippertools/sqlalchemy-14-to-20-codemod/archive/refs/tags/v0.1.2.zip#subdirectory=products/pydantic-v2-porter"
python -m pydantic_v2_porter.cli path/to/your/repo --report migration-report.json

Exit 0 means the scan completed without reported manual-review findings; it does not prove compatibility. Exit 2 means review the reported findings. If installation fails, check Python and network access, then use the quickstart. On PowerShell, you can use .\.zipper-venv\Scripts\python.exe directly if activation is disabled.

2. Interpret the report for free

Open migration-report.json locally. The file_results section lists patterns and findings by file. transforms_applied names candidate categories in a community scan; it does not mean files were changed. A file with blocking findings needs manual review even when it also has supported candidates.

No supported findings detected means only that the scanner found no matching supported patterns. It is not a clean bill of health.

• Few simple candidates: follow the upstream guide and fix them manually.
• Repeated candidates in unblocked files: compare the tested example and decide whether paid automation saves enough work.
• Mostly blocked files: do not buy expecting a complete migration.

The free report is enough to evaluate supported patterns. No paid fit report is required. You can use the official migration guide or the free bump-pydantic codemod. Compare both on a branch before paying.

3. Compare the work before buying

Best fit: an existing Python application with repeated direct Pydantic v1 imports, simple validators, settings imports or Config classes, and tests you can run. For a few edits, use the free report and migrate manually.

Not a complete FastAPI upgrade. Complex validators, aliases and unsupported configuration remain manual work.

Other scanners

SQLAlchemy

python -m venv .zipper-venv
# Windows PowerShell:
.\.zipper-venv\Scripts\Activate.ps1
# macOS / Linux: source .zipper-venv/bin/activate
python -m pip install "https://github.com/zippertools/sqlalchemy-14-to-20-codemod/archive/refs/tags/v0.1.2.zip"
python -m sa20_pack.cli path/to/your/repo --report migration-report.json