pyrift 0.5.0

Quick start — Python API

import pyrift

# Scan a directory
result = pyrift.scan("./src")

print(result)
# ScanResult(files=23, errors=2, warnings=1, score=77)

# Iterate findings
for finding in result.findings:
    print(finding)

# Filter by severity
for error in result.errors:
    print(f"{error.file}:{error.line} — {error.title}")

# Export formats
json_output     = pyrift.to_json(result)
markdown_output = pyrift.to_markdown(result)
text_output     = pyrift.to_text(result)

# Scan a single file
findings = pyrift.scan_file("./src/utils.py")

Rules

CPython rules — version compatibility

PyPy rules — runtime differences

Full rule documentation: docs/rules.md

Use in CI

Add pyrift to your GitHub Actions workflow:

- name: Run pyrift
  run: |
    pip install pyrift
    pyrift scan . --format json --output pyrift-report.json
    pyrift scan .

Exit code is 1 when errors are found — fails the CI build automatically. Use --exit-zero to report without failing.

Use with pre-commit

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/BHUVANSH855/pyrift
    rev: v0.5.0
    hooks:
      - id: pyrift

Why pyrift?

pyrift does not replace any of these tools. It catches what they all miss.

Roadmap

Planned for upcoming versions — contributions welcome:

• CPY046 — typing.TypeIs requires Python 3.13+
• CPY047 — typing.ReadOnly requires Python 3.13+
• Pre-commit hook native support
• VS Code extension
• GitHub Action marketplace listing

See CONTRIBUTING.md to add a rule yourself — rule IDs CPY046+ and PPY046+ are open for community contributions.

Contributing

Contributions are very welcome — especially new rules for behaviour differences you have personally encountered.

See CONTRIBUTING.md for the full guide.

Project status

• Version: 0.5.0
• Rules: 90 (45 CPython + 45 PyPy)
• Tests: 316 passing
• Dependencies: zero
• Python: 3.10+

Author

Built by Bhuvansh Kataria — CPython contributor and PyPy toolkit author.

License

MIT — see LICENSE