Skip to main content

An intelligent Python code quality analyzer with architectural guidance

Project description

pyscn - Python Code Quality Analyzer

Article 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

MCP Integration

Run pyscn analyses straight from AI coding assistants via the Model Context Protocol (MCP). The bundled pyscn-mcp server exposes the same tools used in the CLI to Claude Code, Cursor, ChatGPT, and other MCP clients.

Claude Code Setup

claude mcp add pyscn-mcp uvx -- pyscn-mcp

Cursor / Claude Desktop Setup

Add to your MCP settings (~/.config/claude-desktop/config.json or Cursor settings):

{
  "mcpServers": {
    "pyscn-mcp": {
      "command": "uvx",
      "args": ["pyscn-mcp"],
      "env": {
        "PYSCN_CONFIG": "/path/to/.pyscn.toml"
      }
    }
  }
}

The instructions like "Analyze the code quality" trigger pyscn via MCP.

Dive deeper in mcp/README.md for setup walkthroughs and docs/MCP_INTEGRATION.md for architecture details.

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 Actions
- uses: actions/checkout@v4
- run: pipx run pyscn check .    # Fail on quality issues

# Pre-commit hook
- repo: local
  hooks:
    - id: pyscn
      name: pyscn check
      entry: pipx run pyscn check .
      language: system
      pass_filenames: false
      types: [python]

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

Uploaded Python 3Windows x86-64

pyscn-1.2.2-py3-none-manylinux_2_17_x86_64.whl (7.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

pyscn-1.2.2-py3-none-macosx_11_0_arm64.whl (7.2 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

pyscn-1.2.2-py3-none-macosx_10_9_x86_64.whl (7.7 MB view details)

Uploaded Python 3macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: pyscn-1.2.2-py3-none-win_amd64.whl
  • Upload date:
  • Size: 8.0 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.2.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 f9a794d4bda0efc859e3400bddca0b7764ee20b8b686d0e83573a6c850c57ca2
MD5 76c1bd04f5233ec5cf504228e367603d
BLAKE2b-256 a6aee088db6047e19f805ac2d1fad3f2fd51cd4f673f7659ff1df30a9cb34c54

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.2.2-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 7ac3f18e46ee2f01d50bd873ff893182b5c0c36e98e2f2d2561bf490c804e3bc
MD5 4e6a294cfc38b379bfc6531e4e0e2726
BLAKE2b-256 950454e5a259c7160c800b565e73800da30d13bb4bb0e4bb57f4dcfbe1f82da8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyscn-1.2.2-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 7.2 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.2.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 29f7850cc5f88a7464eb8f0c862c0f7bf58e31b32b2464345b6da6e7fa44d4d2
MD5 172e46ece623763d3bc553389ca9fd85
BLAKE2b-256 fe95848364e7883f360c9bb814e0bf7a2935992283bb686ff634a9fa954a3584

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.2.2-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 507750e2fd49b4cc6737ff6e13d824d54e68a419923c54ef44b835c291cc40c1
MD5 4205ac4b71faaa2850378f20f315dc5c
BLAKE2b-256 bb6166a427ee3f16d433fda901a5aef6f1a30692a800e064d5956fd0e079eac7

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