Skip to main content

An intelligent Python code quality analyzer with architectural guidance

Project description

pyscn - Python Code Quality Analyzer

PyPI Go License CI

pyscn is a code quality analyzer for Python vibe coders.

Building with Cursor, Claude, or ChatGPT? pyscn performs structural analysis to keep your codebase maintainable.

Quick Start

# Run analysis without installation
uvx pyscn analyze .
# or
pipx run pyscn analyze .

Demo

https://github.com/user-attachments/assets/07f48070-c0dd-437b-9621-cb3963f863ff

Features

  • 🔍 CFG-based dead code detection – Find unreachable code after exhaustive if-elif-else chains
  • 📋 Clone detection with APTED + LSH – Identify refactoring opportunities with tree edit distance
  • 🔗 Coupling metrics (CBO) – Track architecture quality and module dependencies
  • 📊 Cyclomatic complexity analysis – Spot functions that need breaking down

100,000+ lines/sec • Built with Go + tree-sitter

Common Commands

pyscn analyze

Run comprehensive analysis with HTML report

pyscn analyze .                              # All analyses with HTML report
pyscn analyze --json .                       # Generate JSON report
pyscn analyze --select complexity .          # Only complexity analysis
pyscn analyze --select deps .                # Only dependency analysis
pyscn analyze --select complexity,deps,deadcode . # Multiple analyses

pyscn check

Fast CI-friendly quality gate

pyscn check .                      # Quick pass/fail check
pyscn check --max-complexity 15 .  # Custom thresholds

pyscn init

Create configuration file

pyscn init                         # Generate .pyscn.toml

💡 Run pyscn --help or pyscn <command> --help for complete options

Configuration

Create a .pyscn.toml file or add [tool.pyscn] to your pyproject.toml:

# .pyscn.toml
[complexity]
max_complexity = 15

[dead_code]
min_severity = "warning"

[output]
directory = "reports"

⚙️ Run pyscn init to generate a full configuration file with all available options

Installation

# Install with pipx (recommended)
pipx install pyscn

# Or run directly with uvx
uvx pyscn
Alternative installation methods

Build from source

git clone https://github.com/ludo-technologies/pyscn.git
cd pyscn
make build

Go install

go install github.com/ludo-technologies/pyscn/cmd/pyscn@latest

CI/CD Integration

# .github/workflows/code-quality.yml
name: Code Quality
on: [push, pull_request]

jobs:
  quality-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: pip install pyscn
      - name: Quick quality check
        run: pyscn check .
      - name: Generate detailed report
        run: pyscn analyze --json --select complexity,deadcode,deps src/
      - name: Upload report
        uses: actions/upload-artifact@v4
        with:
          name: code-quality-report
          path: .pyscn/reports/

Documentation

📚 Development GuideArchitectureTesting

Enterprise Support

For commercial support, custom integrations, or consulting services, contact us at contact@ludo-tech.org

License

MIT License — see LICENSE


Built with ❤️ using Go and tree-sitter

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

pyscn-1.0.1-py3-none-win_amd64.whl (4.9 MB view details)

Uploaded Python 3Windows x86-64

pyscn-1.0.1-py3-none-manylinux_2_17_x86_64.whl (4.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

pyscn-1.0.1-py3-none-macosx_11_0_arm64.whl (4.4 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

pyscn-1.0.1-py3-none-macosx_10_9_x86_64.whl (4.7 MB view details)

Uploaded Python 3macOS 10.9+ x86-64

File details

Details for the file pyscn-1.0.1-py3-none-win_amd64.whl.

File metadata

  • Download URL: pyscn-1.0.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 4.9 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyscn-1.0.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 13be968c762e5e8429dc4636634390f9dbd1dc41bec99830a8067f9db3efa14b
MD5 2f8641ee228621703856abdbcc03c6c4
BLAKE2b-256 2985443abd67fb89bf3e4cda721df7cf56aad7919f422d31d1d33da503adfa01

See more details on using hashes here.

File details

Details for the file pyscn-1.0.1-py3-none-manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for pyscn-1.0.1-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 c6ad1615648d5b470db9b9df02672a467912c4d2e33831adc67438a31ee89a2b
MD5 80726cf62db4578756892cbf21d0d6ba
BLAKE2b-256 7479ee3e9ee7b30dce6aaa60554105a822fa710ac0c4f8528e91cf697605d2b3

See more details on using hashes here.

File details

Details for the file pyscn-1.0.1-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyscn-1.0.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 16298224b14593c9320c353144ce2331257ff10e25a480b3b30c895d9a0355c7
MD5 af37ff3f1c81f2bb7977107e63e7752d
BLAKE2b-256 4899cce83874e45b7c6f570a244902f785662b83804cc4f4c60da1bcd298c7ba

See more details on using hashes here.

File details

Details for the file pyscn-1.0.1-py3-none-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for pyscn-1.0.1-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 fc65c913bffaf35d0862222d09b12db28e00e8790a210e4ee1ce903281601fe9
MD5 ea550a8eb3fda3289f40e99697e17f7e
BLAKE2b-256 2f51979394f6af231f26ec7529386ad81cfa65e0c2148dd48183c2e968a534a4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page