Skip to main content

English | 日本語 | 简体中文 | Français


pyscn

A code quality analyzer for Python vibe coders.

Building with Cursor, Claude, or ChatGPT? pyscn performs structural analysis to keep your codebase maintainable.

Article PyPI Downloads Go License

Working with JavaScript/TypeScript? Check out jscan

Quick Start

# Run analysis without installation
uvx pyscn@latest analyze .
# or
pipx run pyscn analyze .

Demo

https://github.com/user-attachments/assets/71d7a126-9c5e-4254-99f4-f2cdedd526ad

Features

One command scores your whole codebase (0-100 with an A-F grade) and generates an HTML report that shows what to fix first.

pyscn looks at your code from five angles:

  • 🧹 Dead code - unreachable code you can safely delete
  • 📋 Duplicate code - copy-pasted and structurally similar code worth merging (Type 1-4 clone detection)
  • 🌀 Complexity - functions that are hard to read and test (cyclomatic and cognitive complexity)
  • 🏗️ Architecture - circular imports, layer rule violations (clean / layered / hexagonal / MVC presets), and auto-detected module communities that reveal how your code is actually structured
  • 🧩 Class design - classes that do too much or depend on too much (CBO coupling, LCOM4 cohesion)

100,000+ lines/sec • Built with Go + tree-sitter

AI Agent Integration

pyscn ships Agent Skills that teach AI coding agents when and how to run each analysis: health checks, refactoring, architecture review, and CI-friendly reports.

Agent Skills (Recommended)

uvx add-skills ludo-technologies/pyscn

This installs the Skills into your project. They work with Claude Code, Cursor, Codex, Gemini CLI, and many other agents (add --agent cursor etc. to target one, --global for all projects).

Then just ask your agent:

  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"

MCP Server (Optional)

For tighter integration, the bundled pyscn-mcp server exposes the same analyses as MCP tools to Claude Code, Cursor, ChatGPT, and other MCP clients.

Claude Code plugin (sets up the MCP server and the Skills together):

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

Manual setup for Claude Code:

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

Cursor / Claude Desktop: 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"
      }
    }
  }
}

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 analyze --skip-communities .           # Skip module community detection

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 --select di .             # Detect DI anti-patterns (opt-in)
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

📖 pyscn documentation site — installation, rule catalog, CLI reference, configuration, output specification

For contributors: 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

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

Uploaded Python 3Windows x86-64

pyscn-1.26.2-py3-none-manylinux_2_17_x86_64.whl (10.8 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

pyscn-1.26.2-py3-none-macosx_11_0_arm64.whl (9.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

File details

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

File metadata

  • Download URL: pyscn-1.26.2-py3-none-win_amd64.whl
  • Upload date:
  • Size: 11.2 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyscn-1.26.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 2a7e8858f6daa216f307f859dbaa4f86f50f5be4249d21fe2b08f50e28dd9ee5
MD5 75cc328c79edda51268a15aba317f62a
BLAKE2b-256 ba26e795990007fea5cc69a3c4313772c78a08a37202128ae42a8d82058b7edd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.26.2-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 4df1bac198d6e14e572f76dd00af44e81dc26ff326c483d64dfe5b5f91948c24
MD5 f61f82dccf1a1642b027e308cae0d501
BLAKE2b-256 c7af0f7aeb151fa5a5034b4ad2bac31b9e07b58963d2a77494ecda2fba7b1c2e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.26.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2e9254516b51109d7121a76d371bd5a1cc07fb551a8e07d03c7b19f0b84778b9
MD5 550ceca02d00858a4ba5c36c602c6db9
BLAKE2b-256 6688c17bd012952406d83430c0d744f017651f6ae9ff7c6c011707cafd47cd20

See more details on using hashes here.

Release history Release notifications | RSS feed

1.29.1

3 files

1.29.0

3 files

1.28.0

3 files

1.27.0

3 files

1.26.4

3 files

1.26.3

3 files

This release

1.26.2 This release

3 files

1.26.1

3 files

1.26.0

3 files

1.25.0

3 files

1.24.3

3 files

1.24.2

3 files

1.24.1

3 files

1.24.0

3 files

1.23.2

3 files

1.23.1

3 files

1.23.0

3 files

1.22.9

3 files

1.22.8

3 files

1.22.7

3 files

1.22.6

3 files

1.22.5

3 files

1.22.4

3 files

1.22.3

3 files

1.22.2

3 files

1.22.1

3 files

1.22.0

3 files

1.21.1

3 files

1.21.0

3 files

1.20.0

3 files

1.19.3

3 files

1.19.2

3 files

1.19.1

3 files

1.19.0

3 files

1.18.1

3 files

1.18.0

3 files

1.17.0

3 files

1.16.0

3 files

1.15.0

3 files

1.14.0

3 files

1.13.0

3 files

1.12.0

3 files

1.11.1

3 files

1.11.0

3 files

1.10.2

3 files

1.10.1

3 files

1.9.3

3 files

1.9.2

3 files

1.9.1

3 files

1.9.0

3 files

1.8.2

3 files

1.8.1

3 files

1.8.0

3 files

1.7.1

3 files

1.7.0

3 files

1.6.0

3 files

1.5.5

3 files

1.5.4

3 files

1.5.3

3 files

1.5.2

3 files

1.5.1

3 files

1.5.0

4 files

1.4.2

4 files

1.4.1

4 files

1.4.0

4 files

1.3.0

4 files

1.2.2

4 files

1.2.1

4 files

1.2.0

4 files

1.1.1

4 files

1.1.0

4 files

1.0.3

4 files

1.0.2

4 files

1.0.1

4 files

1.0.0

4 files

0.0.0.dev0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page