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

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3macOS 11.0+ ARM64

pyscn-1.1.0-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.1.0-py3-none-win_amd64.whl.

File metadata

  • Download URL: pyscn-1.1.0-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.1.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 6387007c435d3ed0581f128080d00928b59952c3978a89462c1f8e9aa0198a71
MD5 ab77e03492fcbc5f82b5fe488f18d902
BLAKE2b-256 c2ed9dba0557c697bfc7a4458f52265693ee5aedfe55bcb2c1094ca5d5a666e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.1.0-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 2fbe5459228cc78fabac5f1e9c27743a5aa3562b5247b9dd98846aa95ca630fc
MD5 1eda18a01b8d504f352206c0c53fa5de
BLAKE2b-256 83e8ab54cd0add1ab38ecd0e588ada4f34158b11af337ff153375bfbb4c6c86c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyscn-1.1.0-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.1.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 6237b6555577b9fea45c592721e4032990c1a90b9e3da0c0195d2f8c1c9f9d9b
MD5 98372e0e527d93b9b939b231b5498855
BLAKE2b-256 493a56aa6fa84802f20f5f5769ec8db732f43d4e742dea93d591681196d8e57e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.1.0-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 51caa14c45f242fbdd141c5cf3660f6d0b3a804efebfd18a6e92702e331048df
MD5 ebe7477bd54029bb4aeaab9d2dd7b236
BLAKE2b-256 578f5d715fa184921430429354e9c55e28cb62c2cca4250e6136161020c9ebc7

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