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/10c747b3-e566-4c30-b873-6755750170a0

Features

  • 🔍 CFG-based dead code detection – Find unreachable code after exhaustive if-elif-else chains
  • 📋 Multi-algorithm clone detection (Type 1-4) – Identify refactoring opportunities with LSH acceleration
  • 🔗 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

Option 1: Install via Plugin Marketplace (Recommended)

claude plugin marketplace add ludo-technologies/pyscn
claude plugin install pyscn-mcp@pyscn-marketplace

Option 2: Manual MCP 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.9.1-py3-none-win_amd64.whl (7.7 MB view details)

Uploaded Python 3Windows x86-64

pyscn-1.9.1-py3-none-manylinux_2_17_x86_64.whl (7.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

pyscn-1.9.1-py3-none-macosx_11_0_arm64.whl (6.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: pyscn-1.9.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 7.7 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.9.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 1460556e99579e2782996ecfb83de75c95d85498782c36675394bccc1394b3df
MD5 9c6007d9cfe226a555f1283a558d9f0a
BLAKE2b-256 976faa96378dfa921373b05e0b4c91bdf66521b807b82247031ed4c960a51011

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.9.1-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 04b40f4c1c9cfd93d01139a514de030e1083bd85fa58cbd105df4ab258d3854a
MD5 a83f514a2750ffacbe27b19087f068b8
BLAKE2b-256 608a06c0156d7edfeae4b3943966921dff001bf90f5bf4557df50de4f386565b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyscn-1.9.1-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 6.9 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.9.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9ed54c64173d8cb8ce5eaa090525c7e431d13bea2b0fe1c1019d2f7118897289
MD5 4b5582bdd28fc03e8d6e0257395e7fe3
BLAKE2b-256 389834917ebd1e30181740f8f99c4d93e7d2643d9c631b837ef6ff4a6042317d

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