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

# Add pyscn MCP server with one command
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.0-py3-none-win_amd64.whl (8.0 MB view details)

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.17+ x86-64

pyscn-1.2.0-py3-none-macosx_11_0_arm64.whl (7.1 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

pyscn-1.2.0-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.0-py3-none-win_amd64.whl.

File metadata

  • Download URL: pyscn-1.2.0-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.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 d013d4e88b49cc3a67871253fd6b07370d6ce8b53d5b7f84050a41d0e0fafc7e
MD5 7f56d3c674c54777f8186c77e1f69a30
BLAKE2b-256 bf41b2f677af48ccee899f4162995b87f94d5a47559c723218839e70e58942d3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.2.0-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 369ad8fe92f1b605ca8387bae387b6a3cc98e45e19b319eea5dddee39d1c9bde
MD5 1fb86525dc6ef90efb5e5c85d3ceb5eb
BLAKE2b-256 8aa2ea2a8b9d07f8ce8630a5b30abcc21acc8c95777900e4fa071a14cd89fbb2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyscn-1.2.0-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 7.1 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.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ee0d51c3a3491bb8e55db215a7fcf1b1b576f93674efbc0691a6154d280dcb8e
MD5 1ddbd7435e0f27844e2a1beaf247517d
BLAKE2b-256 855fe996c349534e38c308b37a5c704542317da9014ed7a622ea0fa2918d305a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyscn-1.2.0-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 6f4391b537d084f09238c4bb594888284661d20ff3a608fadf80d79c49663903
MD5 0acf3d3270aa6d65a2fb766a0ab0a299
BLAKE2b-256 091741028627bf9dd276e1863f9d5c85256caffcb07d0a0ac45c6fa7655c6805

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