Metadata-Version: 2.5
Name: radixcodemap
Version: 0.6.0
Summary: Summarize code repositories quickly and (soon) with multiple verbosity levels
Project-URL: Homepage, https://github.com/jdotpy/radix-map
Project-URL: Repository, https://github.com/jdotpy/radix-map
Project-URL: Download, https://github.com/jdotpy/radix-map/tarball/master
Author-email: KJ <jdotpy@users.noreply.github.com>
License: MIT
License-File: LICENSE
Keywords: tools
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: tree-sitter>=0.20.0
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Provides-Extra: go
Requires-Dist: tree-sitter-go; extra == 'go'
Provides-Extra: javascript
Requires-Dist: tree-sitter-javascript; extra == 'javascript'
Provides-Extra: python
Requires-Dist: tree-sitter-python; extra == 'python'
Provides-Extra: scala
Requires-Dist: tree-sitter-scala; extra == 'scala'
Description-Content-Type: text/markdown



# 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 | 
| Scala | ✅ | tree-sitter-scala | 

```

