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.

Working with JavaScript/TypeScript? Check out jscan

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.

MCP Use Cases

You can interact with pyscn with your AI coding tools:

  1. "Analyze the code quality of the app/ directory"

  2. "Find duplicate code and help me refactor it"

  3. "Show me complex code and help me simplify it"

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 check --max-cycles 0 .          # Only allow 0 cycle dependency
pyscn check --select deps .           # Check only for circular dependencies
pyscn check --allow-circular-deps .   # Allow circular dependencies (warning only)

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

Pyscn Bot (GitHub App)

pyscn-bot monitors your Python code quality automatically.

Features

  • PR Code Review - Automatic code review on every pull request
  • Weekly Code Audit - Scans your entire repository and creates issues for architectural problems

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

Uploaded Python 3Windows x86-64

pyscn-1.6.0-py3-none-manylinux_2_17_x86_64.whl (7.3 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

pyscn-1.6.0-py3-none-macosx_11_0_arm64.whl (6.8 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: pyscn-1.6.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 7.6 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.6.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 ab83012c88aac336cb7a290ca11daae755e9f4e48207c739d15a42d3460abf70
MD5 b11e15fddecebe4f7cb2002aa6fd1413
BLAKE2b-256 59f1183a68e7742976268e0adbfe7903c1f54c5c7923abe9e85729c7b4556843

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.6.0-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 43c3095d7403599d3991f8927cdbcc888a62b5241b1436600e3fa7ee2c2462be
MD5 9485572490e03e2923ec53c3f5d36644
BLAKE2b-256 d5d2c3ece5e72d42815fe1d85287fdfff65c6f1c47daf182a81691a73f6acab8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.6.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0d7fac80fad4d8f3e4da79b358f2b99f26323aad2ef6ec7229c627aa5027c9b5
MD5 eb305dae1a5c148cecb4027c75570068
BLAKE2b-256 41d23344db23a981cdcaea4dadabe932017a4b3a02cc183463e2514de32f19f3

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