Metadata-Version: 2.4
Name: arborix
Version: 1.0.0
Summary: A beautifully structured CLI tree viewer with exports
Home-page: https://github.com/mallikmusaddiq1/arborix
Author: Mallik Mohammed Musaddiq
Author-email: Mallik Mohammed Musaddiq <mallikmusaddiq1@gmail.com>
License: MIT License
        
        Copyright (c) 2025 mallikmusaddiq1
        
        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/mallikmusaddiq1/arborix
Project-URL: Repository, https://github.com/mallikmusaddiq1/arborix
Project-URL: Issues, https://github.com/mallikmusaddiq1/arborix/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# Arborix

**A beautifully structured CLI tree viewer with export capabilities**

---

## Overview

**Arborix** is a minimalist, yet feature-rich command-line utility that renders directory trees in a clean and human-readable format. It leverages UTF-8 icons to intuitively represent various file types and offers multi-format export options for versatile use cases.

### Key Features

* 📁 Unicode icons for different file types
* 📄 Export to `.txt`, `.json`, and `.html` (with embedded CSS)
* 🧠 Sorting by name, size, or date
* 🫥 Toggle hidden files
* 🌈 Colored terminal output
* 🔍 Depth limitation for focused navigation
* 📊 Directory statistics on demand

---

## Installation

Choose from the following methods:

### From GitHub

```bash
pip install git+https://github.com/mallikmusaddiq1/arborix.git
cd arborix
pip install .
```

### From PyPI

```bash
pip install arborix
```

---

## Usage

Launch Arborix from your terminal:

```bash
arborix [path] [options]
```

### Command-line Options

* `-d, --depth <int>`: Set tree depth limit (e.g., `--depth 3`)
* `--txt <file>`: Export tree view to `.txt`
* `--json <file>`: Export tree structure to `.json`
* `--html <file>`: Export to `.html` with embedded styles
* `--sort <name|size|date>`: Sort directory entries (default: name)
* `-H, --hidden`: Include hidden files and folders
* `--no-icons`: Disable Unicode icons
* `--color`: Enable ANSI-colored output
* `--stats`: Display summary of files and directories
* `-v, --version`: Show tool version and author information

---

## Example Commands

Generate a basic tree with stats and export:

```bash
arborix . --depth 2 --txt output.txt --stats
```

Export to JSON with colored output and hidden files:

```bash
arborix . --json structure.json --color --hidden
```

Generate icon-free HTML output for a directory:

```bash
arborix /path/to/dir --html index.html --no-icons
```

Display version and credits:

```bash
arborix --version
```

---

## File Type Icons

| Icon | Category         | File Types              |
| ---- | ---------------- | ----------------------- |
| 📁   | Folder           | Directories             |
| 📸   | Image            | jpg, png, svg, psd      |
| 🎵   | Audio            | mp3, wav, flac, ogg     |
| 🎬   | Video            | mp4, mkv, avi, mov      |
| 📄   | Text & Code      | txt, py, java, html     |
| 🗜️  | Archive          | zip, rar, tar, 7z       |
| ⚙️   | Executable       | exe, bin, jar, sh       |
| 🔤   | Font             | ttf, otf, woff, woff2   |
| 🗄️  | Database         | sql, sqlite, db         |
| 📊   | Presentation     | ppt, pptx, odp          |
| 📈   | Spreadsheet      | xls, xlsx, ods          |
| 📖   | PDF & E-books    | pdf, epub, mobi         |
| 📐   | CAD & 3D Models  | dwg, stl, obj           |
| 📦   | Miscellaneous    | torrent, tmp, cfg       |
| 💾   | Virtual Machines | vmdk, vmx, vdi          |
| 🎮   | Game Files       | rom, nes, gba           |
| 🔬   | Scientific Data  | hdf, npy, pdb           |
| ✍️   | Markup & Docs    | md, tex, adoc           |
| 📦   | Other            | Unrecognized extensions |

---

## Author

**Mallik Mohammed Musaddiq**

**GitHub: [@mallikmusaddiq1](https://github.com/mallikmusaddiq1)**

**Email: [mallikmusaddiq1@gmail.com](mailto:mallikmusaddiq1@gmail.com)**

---

## License

This project is licensed under the MIT License. Refer to the [LICENSE](LICENSE) file for full details.
