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/b7e9d72e-0845-4a1e-a6a0-e34e00ed8a39

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

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-0.7.0b1-py3-none-win_amd64.whl (4.9 MB view details)

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3macOS 11.0+ ARM64

pyscn-0.7.0b1-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-0.7.0b1-py3-none-win_amd64.whl.

File metadata

  • Download URL: pyscn-0.7.0b1-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-0.7.0b1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 60e2c89955ef8270023292f7e89a2aa12364d50c56eb9d36ca2c68c884727f15
MD5 8ed3ee5711965f19bc9fd598355eca66
BLAKE2b-256 1e190ecb0b75948443718b59f625276bdee79855b9de867d7962dd3bc732437b

See more details on using hashes here.

File details

Details for the file pyscn-0.7.0b1-py3-none-manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for pyscn-0.7.0b1-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 5ab6308f73c388e5d06a3b1c071dc7dfeac6bba34597b35fa2f27d02270ae1e4
MD5 903547ec8df674915ae9593b81d27334
BLAKE2b-256 c0bff48fff977f77139cff8277e8441044593aa70b9a9e281a7faca1faf224e3

See more details on using hashes here.

File details

Details for the file pyscn-0.7.0b1-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyscn-0.7.0b1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 957e10f3ae667346241e2dbbba91c8b835bab99181e1e95031039d3ff16adf5c
MD5 a046304e986f668ab2c3547ddff56fea
BLAKE2b-256 065895282ebda5280473eb4bbc0b1a74555c8413beb2c2e0fa2d59f0b7854ff5

See more details on using hashes here.

File details

Details for the file pyscn-0.7.0b1-py3-none-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for pyscn-0.7.0b1-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 d6423d767128e32fcd2923f0141af339bfb732a332c8b1fce82962a0f1ad37a7
MD5 343434dc0511bd2f87559f323cd2eedd
BLAKE2b-256 c3e9654b1e0f0d5807f390c4927840ed6cdb6e6459bb0571f827538592659c89

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