Skip to main content

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


pyscn

Code quality analysis for Python in the age of AI coding.

Building with Cursor, Claude, or ChatGPT? pyscn keeps AI-generated code maintainable with structural analysis.

Article PyPI Downloads Go License

Track your codebase's health every week with Polyscan.
Automatically monitor complexity, duplication, and dead code, with changes delivered as a GitHub Issue.
Set up weekly monitoring → · Free for public repositories

Quick Start

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

Demo

pyscn analysis report

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 and executable class suites that are hard to read and test (cyclomatic and cognitive complexity)
  • 🔥 Module and directory hotspots - per-file quality and per-directory complexity rollups for prioritizing refactors
  • 🏗️ 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

Working with other languages? pyscn is part of polyscan, code quality analyzers for JavaScript/TypeScript and more.

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.

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

macOS Intel (x86_64): PyPI wheels are built for Apple Silicon only (the Intel wheel was dropped in v1.5.1), so uvx, pipx, uv, and pip cannot install pyscn on Intel Macs. Use brew install pyscn or go install github.com/ludo-technologies/pyscn/cmd/pyscn@latest instead.

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 --json --output - . | jq       # JSON report on stdout
pyscn analyze --json --html --no-open .      # JSON and HTML reports from one run
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


Documentation

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

For contributors: Development Guide • Architecture • Testing

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

Metadata

Release files for pyscn 1.32.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for pyscn 1.32.1
File
pyscn-1.32.1-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details
pyscn-1.32.1-py3-none-manylinux_2_34_x86_64.whl Python 3 none Linux glibc 2.34+ x86-64 Details
pyscn-1.32.1-py3-none-manylinux_2_34_aarch64.whl Python 3 none Linux glibc 2.34+ ARM64 Details
pyscn-1.32.1-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details

Total release size: 43.3 MB

Release files / pyscn-1.32.1-py3-none-win_amd64.whl

Download URL pyscn-1.32.1-py3-none-win_amd64.whl
Size 11.7 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
0c776ac90e2fa706cee5dcde279fcd5128088cdb09abd21f45483a538d3b434a
BLAKE2b-256 checksum
How to use checksums
a88b1ba8a72ce2ba223d02e1e425b12e801d3f35fd70a8629b813256d10e1585
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pyscn-1.32.1-py3-none-manylinux_2_34_x86_64.whl

Download URL pyscn-1.32.1-py3-none-manylinux_2_34_x86_64.whl
Size 11.2 MB
Tags Linux glibc 2.34+ x86-64 Python 3
SHA-256 checksum
How to use checksums
9bbbb6760c844e054a2891af11803d89e965e91f06d45a59dc3d7103f83852bd
BLAKE2b-256 checksum
How to use checksums
a36e6a9a2c7573690404a26945b1309fd6242d1886b8d4da18e8f58ec4925552
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pyscn-1.32.1-py3-none-manylinux_2_34_aarch64.whl

Download URL pyscn-1.32.1-py3-none-manylinux_2_34_aarch64.whl
Size 10.1 MB
Tags Linux glibc 2.34+ ARM64 Python 3
SHA-256 checksum
How to use checksums
9e4e1c214ecf9b05c5438fa259466a663dd1e6d81f1d79a3796f5518ee52edee
BLAKE2b-256 checksum
How to use checksums
ec3db86b32c3bce452ffe8a3348f0c5531672e157ee604c6cd11c4fa1bd8a939
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / pyscn-1.32.1-py3-none-macosx_11_0_arm64.whl

Download URL pyscn-1.32.1-py3-none-macosx_11_0_arm64.whl
Size 10.3 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
dc922aaba7da63e3ea931e26152bbd3a0c3f4f8330921f969c863dab2822bca8
BLAKE2b-256 checksum
How to use checksums
d2f6af6d115f05e4f75e3227e046bcbdd876f0c911b67203afa4dc6ddc0c8e1e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

1.32.2

4 release files

This release

1.32.1 This release

4 release files

1.32.0

4 release files

1.31.3

4 release files

1.31.2

4 release files

1.30.0

3 release files

1.29.1

3 release files

1.29.0

3 release files

1.28.0

3 release files

1.27.0

3 release files

1.26.4

3 release files

1.26.3

3 release files

1.24.3

3 release files

1.24.2

3 release files

1.24.1

3 release files

1.24.0

3 release files

1.23.2

3 release files

1.22.6

3 release files

1.22.5

3 release files

1.22.4

3 release files

1.22.3

3 release files

1.22.2

3 release files

1.22.1

3 release files

1.22.0

3 release files

1.21.1

3 release files

1.21.0

3 release files

1.20.0

3 release files

1.19.3

3 release files

1.19.2

3 release files

1.18.0

3 release files

1.17.0

3 release files

1.16.0

3 release files

1.14.0

3 release files

1.13.0

3 release files

1.11.1

3 release files

1.11.0

3 release files

1.9.3

3 release files

1.9.2

3 release files

1.9.1

3 release files

1.9.0

3 release files

1.8.2

3 release files

1.8.1

3 release files

1.8.0

3 release files

1.7.1

3 release files

1.7.0

3 release files

1.6.0

3 release files

1.5.5

3 release files

1.5.4

3 release files

1.5.3

3 release files

1.5.2

3 release files

1.5.1

3 release files

1.5.0

4 release files

1.4.2

4 release files

1.4.1

4 release files

1.4.0

4 release files

1.3.0

4 release files

1.2.2

4 release files

1.2.1

4 release files

1.2.0

4 release files

1.1.1

4 release files

1.1.0

4 release files

1.0.3

4 release files

1.0.2

4 release files

1.0.1

4 release files

1.0.0

4 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page