Metadata-Version: 2.4
Name: lorax-tree
Version: 0.1.0
Summary: A tiny tool to print a clean directory tree.
Author: Rudy van den Brink
License: MIT License
        
        Copyright (c) 2025 Rudy van den Brink
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/rudyvdbrink/Lorax
Project-URL: Source, https://github.com/rudyvdbrink/Lorax
Keywords: tree,directory,structure,docs,readme
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pathspec>=0.12
Dynamic: license-file

# Lorax

Lorax speaks for the trees: it prints a clean directory tree for your project, excluding heavy / generated directories like virtual environments, build artifacts, and caches — useful for project overviews in a `README.md`.

## Installation

```bash
pip install lorax-tree
```

## Usage

```python
from lorax import Lorax

lorax = Lorax(".")
lorax.speak()
```

This prints a tree for the current working directory, for example:

```text
Lorax/
├── .git/
├── .venv/
├── src/
│   └── lorax/
│       ├── __init__.py
│       ├── __main__.py
│       └── lorax.py
├── .gitignore
├── LICENSE
├── pyproject.toml
└── README.md
```

