Skip to main content

Multi-level code structure explorer — interactive drill-down HTML visualizations

Project description

Codezoom

Multi-level code structure explorer — interactive drill-down HTML visualizations.

Codezoom generates a standalone HTML file that lets you explore a project's structure at multiple levels of detail. Click any node to drill down; use breadcrumb navigation to go back up.

What it visualizes

Level Python Java
1. External dependencies Direct and transitive packages from pyproject.toml + uv.lock Direct and transitive Maven dependencies from pom.xml (requires jgo)
2. Package/module hierarchy Sub-packages and modules via pydeps (with file-tree fallback) — includes inter-module imports Package tree via jdeps — includes inter-package dependencies and class-level call graphs
3. Module/class internals Functions and classes extracted from AST — shows visibility (public/private based on naming) Classes, interfaces, enums, and nested classes extracted from compiled bytecode via javap — shows visibility (public/protected/private/package)
4. Class/method internals Methods and their call relationships extracted from AST Methods with parameter signatures and call relationships extracted from bytecode

Examples


External dependencies (Python)

External dependencies (Java)

Project submodules

A submodule's children

Single-file view (Python)

Single-file view (Java)

Installation

Installing codezoom with uv
uv tool install codezoom
Installing codezoom with pip
pip install codezoom
Installing codezoom from source
git clone https://github.com/apposed/codezoom
uv tool install --with-editable codezoom codezoom

When installed in this fashion, changes to the codezoom source code will be immediately reflected when running codezoom from the command line.

Using codezoom as a dependency
uv add codezoom

or

pixi add --pypi codezoom

Not sure which to use? Read this.

Usage

Basic usage (auto-detects Python or Java):

codezoom /path/to/project                     # auto-detect, output to codezoom.html
codezoom /path/to/project -o output.html      # custom output path
codezoom /path/to/project --name "My Project" # custom display name
codezoom /path/to/project --open              # open in browser after generating

Python projects

# Basic usage - requires pyproject.toml
codezoom /path/to/python/project

# For best results, install pydeps first
pip install pydeps
codezoom /path/to/python/project --open

Java projects

# Compile the project first
cd /path/to/java/project
mvn compile

# Generate visualization (basic - no Maven dependencies)
codezoom . --open

# For full dependency analysis, install jgo
pip install codezoom[java]
codezoom . --open

Also works as a module:

python -m codezoom /path/to/project

Requirements

Core

  • Python 3.11+
  • No mandatory runtime dependencies beyond the standard library

For Python projects

  • Optional: pydeps for richer module-level import analysis (falls back to file-tree scanning without it)
    pip install pydeps
    

For Java projects

  • JDK (not just JRE) — provides jdeps and javap for package/class analysis
  • Compiled code — run mvn compile before analyzing
  • Optional: jgo for Maven dependency extraction
    pip install codezoom[java]
    

Per-project configuration

Projects can include a .codezoom.toml or a [tool.codezoom] section in pyproject.toml:

[tool.codezoom]
exclude = ["tests", "docs", "__pycache__"]

The exclude list is passed to pydeps via -xx to omit modules from the hierarchy.

Language support

Python

  • Detection: Presence of pyproject.toml
  • Project layouts: Both src/ layout and flat layout
  • Dependencies: Extracted from pyproject.toml and uv.lock
  • Hierarchy: Module tree via pydeps (falls back to file tree)
  • Symbols: Functions, classes, and methods via AST parsing
  • Call graphs: Method calls extracted from AST
  • Visibility: Public/private based on Python naming conventions (_private, __dunder__)
  • Configuration: Via .codezoom.toml or [tool.codezoom] in pyproject.toml

Java

  • Detection: Presence of pom.xml or build.gradle.kts or build.gradle
  • Prerequisites:
    • JDK installed (for jdeps and javap)
    • Project compiled (mvn compile or ./gradlew build)
    • pip install codezoom[java] for dependency extraction
  • Dependencies: Maven dependencies via jgo (direct + transitive with scope filtering)
  • Hierarchy: Package tree via jdeps with inter-package dependencies
  • Class dependencies: Class-to-class and class-to-package relationships via javap
  • Symbols: Classes, interfaces, enums, nested classes via bytecode analysis
  • Call graphs: Method invocations extracted from bytecode
  • Visibility: Full Java visibility (public, protected, private, package-private)
  • Limitations: Bridge methods are filtered out; requires compiled .class files

License

UNLICENSE - All copyright disclaimed.

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

codezoom-2.1.0.tar.gz (51.3 kB view details)

Uploaded Source

Built Distribution

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

codezoom-2.1.0-py3-none-any.whl (59.5 kB view details)

Uploaded Python 3

File details

Details for the file codezoom-2.1.0.tar.gz.

File metadata

  • Download URL: codezoom-2.1.0.tar.gz
  • Upload date:
  • Size: 51.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for codezoom-2.1.0.tar.gz
Algorithm Hash digest
SHA256 a9c038b4aadd9b74e3456ea936c3c1f1adaf9c13e60c9f7dff66e0fc5468cd85
MD5 9576ef90353225bd17a844a6b765a70e
BLAKE2b-256 0df11b1d3c875051740ed80b3f2b06d9a97f1550103333c326535c78f5919b03

See more details on using hashes here.

File details

Details for the file codezoom-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: codezoom-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 59.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for codezoom-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5562ab176350ea15d46384dfa1737382ed60f231ea3fae53d0cea36db0ff305c
MD5 f64593a27f935a292196db38025cd79f
BLAKE2b-256 840651bdb7758695230f4103d28cedbbc9cf957edb2a96e5e7ec2285226bc689

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