Skip to main content

Interactive live architecture viewer for Python projects

Project description

ArchView

See your codebase. Understand it. Then change it.

ArchView gives you a live, interactive map of any Python project's architecture — right in your browser. It parses real Python (via AST, not regex), watches for changes, and updates the graph in real time.

Built for developers who vibe-code and need to stay oriented, or anyone inheriting a codebase they didn't write.

ArchView overview — live dependency graph updating as code changes

Drawing annotations — sketching boxes and labels directly on the graph

Why

You're 200 files deep in someone else's project. Or you're building fast and your own code is getting tangled. You need to see the structure — what depends on what, where the entry points are, which modules are isolated.

ArchView shows you all of that in seconds, and keeps updating as you code.

Install

pip install archview

Available on PyPI. Pure Python, works anywhere with Python 3.9+.

Usage

archview /path/to/your/project

Open http://localhost:9090 — that's it.

# Custom port and refresh interval
archview /path/to/project --port 8080 --interval 5

What you see

Color Meaning
Green Entry point — modules that import but aren't imported
Blue Connector — modules that both import and are imported
Red Utility — leaf modules only imported by others
Gray Isolated — no import relationships
Red (bright) Syntax errors — files that failed to parse

Features

Live refresh

Edit your code, save — the graph updates automatically. No restart needed.

Interactive exploration

  • Hover a node to see its docstring, type, and exported symbols
  • Click a node to highlight its direct dependencies
  • Double-click to open the file in VS Code
  • Drag nodes to rearrange the layout
  • Click folders to collapse/expand entire packages

Dependency highlighting

Click a node and it plus its direct dependencies light up — everything else fades. Then hover a highlighted edge to see exactly which symbols are imported across it.

Annotations

Sketch directly on the graph to explain it. Draw boxes, add text labels, erase — useful for walking a teammate through the architecture or marking up a review. Annotations persist across launches.

Export

  • PNG — screenshot the current view
  • Save — persist node positions (restored on next launch)

Ignore patterns

# Exclude directories from analysis
archview ignore tests __pycache__ venv

# List current patterns
archview ignore --list

# Remove a pattern
archview ignore --remove tests

How it works

  1. Collects source files — .py, plus .sh scripts and config files (.yaml/.json) — git-aware, respects .archviewignore
  2. Parses Python via AST (imports, functions, classes); resolves shell-script and config references too
  3. Builds a dependency graph with classified nodes
  4. Renders it with Cytoscape.js + Dagre layout
  5. Watches for changes and re-generates every N seconds

Zero dependencies — pure Python stdlib. The frontend ships bundled.

Example

Try it on the example project (hosted on GitHub):

git clone https://github.com/lm17918/archview.git archview-demo
cd archview-demo
pip install archview
archview examples

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

archview-0.2.5.tar.gz (215.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

archview-0.2.5-py3-none-any.whl (213.5 kB view details)

Uploaded Python 3

File details

Details for the file archview-0.2.5.tar.gz.

File metadata

  • Download URL: archview-0.2.5.tar.gz
  • Upload date:
  • Size: 215.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for archview-0.2.5.tar.gz
Algorithm Hash digest
SHA256 4a736bfb52a6273352b773d68ea2ca09e33a00a657bd32ab2c4c02dbf3a966e4
MD5 0dfaf827e21d8855d04a7ea74cf615a9
BLAKE2b-256 9a669682617b22a6585e96ac994de1e152fbe757aa3159d43b3ee330c09797f0

See more details on using hashes here.

File details

Details for the file archview-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: archview-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 213.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for archview-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 72154a6603ecc13f1815442f54e9425e440d219ec8a9c38d8022e95ee56bf801
MD5 bac396e706634ceb8e35005ead8d28b9
BLAKE2b-256 a2fb94b10986e4de1655940a77f622a2f66a962c145e88046235f72c78e180bc

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