Metadata-Version: 2.4
Name: radixcodemap
Version: 0.3.0
Summary: Summarize code repositories quickly and (soon) with multiple verbosity levels
Home-page: https://github.com/jdotpy/radix-map
Download-URL: https://github.com/jdotpy/radix-map/tarball/master
Author: KJ
Author-email: jdotpy@users.noreply.github.com
Keywords: tools
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tree-sitter
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary



# 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:**
   ```bash
   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:**
   ```bash
   pip install tree-sitter-python
   pip install tree-sitter-go
   pip install tree-sitter-javascript
   ```


## Use
---

```bash
radix map .
```

Example output:
```bash
#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 | 

```

