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

Installation

# Install with pipx (recommended)
pipx install pyscn

# Or with uv
uv tool install 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

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

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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3macOS 11.0+ ARM64

pyscn-1.0.3-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.3-py3-none-win_amd64.whl.

File metadata

  • Download URL: pyscn-1.0.3-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.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 3d308a15c84ac16d47f8c41f72197c5d5b3f2a0c78709638e5ccc5eb89b0a731
MD5 2dd3e7a5ebfb15bf0beb49a952f7637e
BLAKE2b-256 e8785bdece1d1790b4bee79e81533bb49a79eb6be99aedebe11c5ef903891002

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.0.3-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 20aa1d4437472b75981be2bd5e9945e5b2d05ab9b6f34b493fbffbe77b244533
MD5 677ca3c861af53e70fadd98c7ca187fa
BLAKE2b-256 03c0c1e1e449d438b99f8738c130f2b3a93d7709cef9c3d4e1188344dc2fb023

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyscn-1.0.3-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 4.4 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyscn-1.0.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e0af212710f090eec8e44822421092d5ed0e9a3ee4151ca2b9f6b1a9e1b14cd3
MD5 2db0fbdebee3b7560c25a4137ef060ac
BLAKE2b-256 05ceecce8d2148eaf5921d2acc092d2e7d08911579fe892321901925dccb1414

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.0.3-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 9832294f0f8592b601c6225d8bc52ff2aa640530e125d97c93b3a6d731a46db7
MD5 6ce722b8d897ac3bbd05298fde58281f
BLAKE2b-256 2dbff9a7524e8d6b78a9287065fbb2c9f6ffa9270eea45edd2f744c612c0d8d0

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