Skip to main content

Summarize code repositories quickly and (soon) with multiple verbosity levels

Project description

Radix: Configurable SourceCode summarizer

Quickly summarize project structure with multiple verbosity levels (ok, so maybe there's only one option right now lol). More soon.

Installation


  1. Clone the repository:

    git clone [https://github.com/jdotpy/radix-map.git](https://github.com/jdotpy/radix-map.git)
    cd radix-map
    pip install .
    
  2. Install Dependencies based on code you plan on using:

    pip install tree-sitter-python
    pip install tree-sitter-go
    pip install tree-sitter-javascript
    

Use


radix map .

Example output:

#tests/test_integration.py
└── ƒ get_test_pairs()

#tests/snapshots/python_ex1.py
├── ƒ global_helper()
└──  class DataProcessor
    ├── ƒ __init__(self, source: str)
    ├── ƒ process(self)
    └── ƒ _validate(self)

#radix/scanner.py
└──  class ProjectScanner
    ├── ƒ __init__(self, registry, max_bytes: int = 200_000, extra_ignored_dirs: Optional[Set[str]] = None)
    ├── ƒ is_visible(self, path: Path)
    └── ƒ scan(self, target: str)

Supported Languages

Language Status Package Requirement
Python ✅ functions & classes tree-sitter-python
Go 🚧 tree-sitter-go
JavaScript 🚧 tree-sitter-javascript

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

radixcodemap-0.4.2.tar.gz (14.5 kB view details)

Uploaded Source

File details

Details for the file radixcodemap-0.4.2.tar.gz.

File metadata

  • Download URL: radixcodemap-0.4.2.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for radixcodemap-0.4.2.tar.gz
Algorithm Hash digest
SHA256 4b099b6d3781ad9f4a1257ddbdfb5df7448aab5e170c7a269796aa3d6cefd462
MD5 f7c84c17f78cac5ad150ff7f392a935a
BLAKE2b-256 636a9d3a29967a2524c8a8322c287c58417b402e4804eb2301771be2f06457b4

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