rich-tree-cli 0.3.12__tar.gz

rich_tree_cli-0.3.12/.bumpversion.cfg

@@ -0,0 +1,11 @@
+[bumpversion]
+current_version = 0.3.12
+commit = True
+tag = True
+tag_name = v{new_version}
+
+[bumpversion:file:pyproject.toml]
+
+[bumpversion:file:src/rich_tree_cli/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"

rich_tree_cli-0.3.12/.github/workflows/python-app.yml

@@ -0,0 +1,41 @@
+name: Lint and Test Python
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+    - name: Set up Python 3.12
+      run: uv python install 3.12
+    - name: Install dependencies
+      run: |
+        uv sync
+        source .venv/bin/activate
+    - name: Lint with flake8
+      run: |
+        uv run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=.venv
+        uv run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude=.venv
+    - name: Sort imports with isort
+      run: |
+        uv run isort . --check-only --diff --skip .venv --line-length 120
+    - name: Format with black
+      run: |
+        uv run black . --check --diff --exclude=.venv -l 120
+    - name: Test with pytest
+      run: |
+        uv run pytest
+    
+    

rich_tree_cli-0.3.12/.gitignore

@@ -0,0 +1,211 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,macos,shell
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,macos,shell
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+#.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+.vscode/
+
+*.db

rich_tree_cli-0.3.12/.python-version

@@ -0,0 +1 @@
+3.13

rich_tree_cli-0.3.12/AGENTS.md

@@ -0,0 +1,15 @@
+# Contributor Guide for AI Agents
+
+## Dev Environment Guidelines
+
+### Claude Only
+
+<antml:thinking_mode>interleaved</antml:thinking_mode><antml:max_thinking_length>16000</antml:max_thinking_length>
+
+- Python Version and Typing: Assume Python 3.12 or higher is being used. Because of that we SHOULD use the latest typing features available in Python 3.12 and later. Never use `Optional`, `Union`, or `Dict, List, Tuple` from `typing` module. Instead, use the built-in types directly, e.g., `list`, `dict`, `tuple`, and use `|` for union types. This is not an exhaustive list, so be thoughtful about any potentially deprecated types you might use. If you are not sure about something, ask the user.
+- Type Annotations: Use type annotations as often as possible. If a function has no return value, use `None` as the return type. If a function returns a value, use the appropriate type annotation but don't bend over backwards to make it perfect. If you are not sure about the type, use `Any` as a fallback but use this sparingly, see it as a failure and you should endeavor to avoid using `Any` as much as possible.
+- Docstrings: Use docstrings for most (95%) public functions and classes. The docstring should describe the purpose of the function or class, its parameters, and its return value. Use the Google style for docstrings. Because of this it is highly preferred to not use comments in the code unless absolutely necessary. If you feel like you need to use a comment, consider if the code can be refactored to make it more readable instead.
+- Imports: Use relative imports for everything (beyond the obvious imports for external packages) in this current package. Keep imports clean using `uv run isort src tests` and `uv run black src tests` to format the code in that order.
+- Endeavor to use a TDD approach when writing new code. Write tests first, then write the code to make the tests pass and then refactor the code to make it cleaner and more readable.
+- There is a `directory_structure.txt` file in the root of the repository that describes the directory structure of the project. Use this as a quick way to understand the project structure and where to place new files or modules.
+- While projects might partially use Poetry, UV is generally the preferred tool for managing dependencies and virtual environments. It is taking me some time to get used to it, so please bear with me. If you are not sure about something, ask the user.

rich_tree_cli-0.3.12/PKG-INFO

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: rich-tree-cli
+Version: 0.3.12
+Summary: A command-line interface for visualizing directory trees with rich formatting and various options.
+Author-email: chaz <bright.lid5647@fastmail.com>
+Requires-Python: >=3.11
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: pathspec>=0.12.1
+Requires-Dist: rich>=14.0.0
+Requires-Dist: tomli-w>=1.2.0
+Description-Content-Type: text/markdown
+
+# Rich Tree CLI
+
+Rich Tree CLI provides a beautiful, colorful representation of your directory tree using the [rich](https://github.com/Textualize/rich) library. Generate stunning visual directory trees with custom icons, multiple export formats, and intelligent filtering - perfect for documentation, project exploration, and sharing repository structures.
+
+## ✨ Features
+
+- 🎨 **Beautiful terminal output** with colors and custom icons
+- 📁 **Multiple export formats**: HTML, JSON, Markdown, SVG, TOML, and plain text
+- 🔍 **Smart filtering** with built-in gitignore support and custom patterns
+- 📊 **Rich metadata** including file sizes, line counts, and file types
+- 🎯 **VS Code integration** with clickable file links in HTML output
+- ⚡ **Fast and lightweight** with sensible defaults
+- 🛠️ **Highly configurable** sorting, depth limits, and display options
+
+## 🚀 Quick Start
+
+### Installation
+
+Install the CLI globally so it's available from anywhere:
+
+```bash
+pip install rich-tree-cli
+```
+
+Or with uv:
+
+```bash
+uv pip install rich-tree-cli
+```
+
+### Basic Usage
+
+Generate a tree for the current directory:
+
+```bash
+rtree
+```
+
+Limit recursion depth:
+
+```bash
+rtree --depth 2
+```
+
+Export to multiple formats:
+
+```bash
+rtree --output-format html json markdown --output myproject
+```
+
+Show file metadata:
+
+```bash
+rtree --metadata all --depth 3
+```
+
+## 📋 Command Options
+
+```bash
+rtree [DIRECTORY] [OPTIONS]
+```
+
+### Core Options
+
+- `--depth, -d`: Maximum depth of recursion (default: unlimited)
+- `--output, -o`: Output file path (extension determined by format)
+- `--output-format, -f`: Export formats: `text`, `html`, `json`, `markdown`, `svg`, `toml`
+- `--metadata, -m`: Show metadata: `none`, `size`, `lines`, `all`
+
+### Filtering Options
+
+- `--exclude, -e`: Exclude files/directories matching patterns
+- `--gitignore, -g`: Use custom .gitignore file
+- `--sort-order, -s`: Sort order: `files` (files first) or `dirs` (directories first)
+
+### Display Options
+
+- `--icons, -i`: Icon style: `emoji`, `glyphs`, `plain`
+- `--disable-color, -dc`: Disable colored output
+- `--no-console, -no`: Disable console output (export only)
+
+## 🎨 Export Formats
+
+### HTML Export
+
+Creates a beautiful web page with VS Code integration:
+
+- Clickable file links that open in VS Code
+- Custom CSS styling with terminal aesthetics
+- Professional presentation ready for documentation
+
+### Markdown Export
+
+Perfect for README files and documentation:
+
+- Clean, readable format
+- Integrates seamlessly with GitHub/GitLab
+- Great for project overviews
+
+### JSON/TOML Export
+
+Machine-readable formats for automation:
+
+- Complete directory structure data
+- File metadata included
+- Easy integration with other tools
+
+### SVG Export
+
+Vector graphics for presentations and documentation:
+
+- Scalable visual representation
+- Embeddable in web pages and documents
+- High-quality output for any size
+
+## 💡 Examples
+
+### Documentation Generation
+
+```bash
+# Generate project overview for README
+rtree --output-format markdown --output project-structure --depth 3
+
+# Create interactive HTML documentation
+rtree --output-format html --metadata all --output docs/structure
+```
+
+### Development Workflows
+
+```bash
+# Quick project exploration
+rtree --depth 2 --icons emoji
+
+# Share repository structure with team
+rtree --output-format html json --output project-overview --exclude "*.pyc" "__pycache__"
+
+# Generate structure for AI assistance
+rtree --output-format text --metadata size --depth 4
+```
+
+### Advanced Filtering
+
+```bash
+# Exclude build artifacts and dependencies
+rtree --exclude "node_modules" "dist" "build" "*.log"
+
+# Use custom gitignore
+rtree --gitignore .gitignore-custom --depth 5
+
+# Show only directories
+rtree --sort-order dirs --metadata none
+```
+
+## 🏗️ Why Rich Tree CLI?
+
+- **Developer-focused**: Built by developers, for developers, with real workflow needs in mind
+- **Beautiful output**: No more ugly ASCII trees - get professional, presentation-ready visualizations
+- **Flexible exports**: One command, multiple formats - perfect for documentation, sharing, and automation
+- **Smart defaults**: Works great out of the box with sensible gitignore patterns and file detection
+- **VS Code integration**: Seamlessly integrates with your development environment
+
+---
+
+## 🛠️ Built With
+
+- **[Rich](https://github.com/Textualize/rich)** - Beautiful terminal output and formatting
+- **[Jinja2](https://jinja.palletsprojects.com/)** - Powerful HTML template generation  
+- **[pathspec](https://github.com/cpburnz/python-pathspec)** - Gitignore pattern matching
+
+---
+
+*Rich Tree CLI - Making directory structures beautiful, one tree at a time* 🌳

rich_tree_cli-0.3.12/README.md

@@ -0,0 +1,172 @@
+# Rich Tree CLI
+
+Rich Tree CLI provides a beautiful, colorful representation of your directory tree using the [rich](https://github.com/Textualize/rich) library. Generate stunning visual directory trees with custom icons, multiple export formats, and intelligent filtering - perfect for documentation, project exploration, and sharing repository structures.
+
+## ✨ Features
+
+- 🎨 **Beautiful terminal output** with colors and custom icons
+- 📁 **Multiple export formats**: HTML, JSON, Markdown, SVG, TOML, and plain text
+- 🔍 **Smart filtering** with built-in gitignore support and custom patterns
+- 📊 **Rich metadata** including file sizes, line counts, and file types
+- 🎯 **VS Code integration** with clickable file links in HTML output
+- ⚡ **Fast and lightweight** with sensible defaults
+- 🛠️ **Highly configurable** sorting, depth limits, and display options
+
+## 🚀 Quick Start
+
+### Installation
+
+Install the CLI globally so it's available from anywhere:
+
+```bash
+pip install rich-tree-cli
+```
+
+Or with uv:
+
+```bash
+uv pip install rich-tree-cli
+```
+
+### Basic Usage
+
+Generate a tree for the current directory:
+
+```bash
+rtree
+```
+
+Limit recursion depth:
+
+```bash
+rtree --depth 2
+```
+
+Export to multiple formats:
+
+```bash
+rtree --output-format html json markdown --output myproject
+```
+
+Show file metadata:
+
+```bash
+rtree --metadata all --depth 3
+```
+
+## 📋 Command Options
+
+```bash
+rtree [DIRECTORY] [OPTIONS]
+```
+
+### Core Options
+
+- `--depth, -d`: Maximum depth of recursion (default: unlimited)
+- `--output, -o`: Output file path (extension determined by format)
+- `--output-format, -f`: Export formats: `text`, `html`, `json`, `markdown`, `svg`, `toml`
+- `--metadata, -m`: Show metadata: `none`, `size`, `lines`, `all`
+
+### Filtering Options
+
+- `--exclude, -e`: Exclude files/directories matching patterns
+- `--gitignore, -g`: Use custom .gitignore file
+- `--sort-order, -s`: Sort order: `files` (files first) or `dirs` (directories first)
+
+### Display Options
+
+- `--icons, -i`: Icon style: `emoji`, `glyphs`, `plain`
+- `--disable-color, -dc`: Disable colored output
+- `--no-console, -no`: Disable console output (export only)
+
+## 🎨 Export Formats
+
+### HTML Export
+
+Creates a beautiful web page with VS Code integration:
+
+- Clickable file links that open in VS Code
+- Custom CSS styling with terminal aesthetics
+- Professional presentation ready for documentation
+
+### Markdown Export
+
+Perfect for README files and documentation:
+
+- Clean, readable format
+- Integrates seamlessly with GitHub/GitLab
+- Great for project overviews
+
+### JSON/TOML Export
+
+Machine-readable formats for automation:
+
+- Complete directory structure data
+- File metadata included
+- Easy integration with other tools
+
+### SVG Export
+
+Vector graphics for presentations and documentation:
+
+- Scalable visual representation
+- Embeddable in web pages and documents
+- High-quality output for any size
+
+## 💡 Examples
+
+### Documentation Generation
+
+```bash
+# Generate project overview for README
+rtree --output-format markdown --output project-structure --depth 3
+
+# Create interactive HTML documentation
+rtree --output-format html --metadata all --output docs/structure
+```
+
+### Development Workflows
+
+```bash
+# Quick project exploration
+rtree --depth 2 --icons emoji
+
+# Share repository structure with team
+rtree --output-format html json --output project-overview --exclude "*.pyc" "__pycache__"
+
+# Generate structure for AI assistance
+rtree --output-format text --metadata size --depth 4
+```
+
+### Advanced Filtering
+
+```bash
+# Exclude build artifacts and dependencies
+rtree --exclude "node_modules" "dist" "build" "*.log"
+
+# Use custom gitignore
+rtree --gitignore .gitignore-custom --depth 5
+
+# Show only directories
+rtree --sort-order dirs --metadata none
+```
+
+## 🏗️ Why Rich Tree CLI?
+
+- **Developer-focused**: Built by developers, for developers, with real workflow needs in mind
+- **Beautiful output**: No more ugly ASCII trees - get professional, presentation-ready visualizations
+- **Flexible exports**: One command, multiple formats - perfect for documentation, sharing, and automation
+- **Smart defaults**: Works great out of the box with sensible gitignore patterns and file detection
+- **VS Code integration**: Seamlessly integrates with your development environment
+
+---
+
+## 🛠️ Built With
+
+- **[Rich](https://github.com/Textualize/rich)** - Beautiful terminal output and formatting
+- **[Jinja2](https://jinja.palletsprojects.com/)** - Powerful HTML template generation  
+- **[pathspec](https://github.com/cpburnz/python-pathspec)** - Gitignore pattern matching
+
+---
+
+*Rich Tree CLI - Making directory structures beautiful, one tree at a time* 🌳

rich_tree_cli-0.3.12/TODO.md

@@ -0,0 +1,22 @@
+# TODO: List for the project
+
+- [x] Add support for passing a `.gitignore` file using custom ignore patterns in the ignore handler.
+- [x] Implement a feature to handle `.gitignore` files in the ignore handler.
+- [x] Add output features beyond just basic plaintext output.
+- [x] Markdown output format
+- [x] HTML output format
+- [x] JSON output format
+- [x] Add SVG output format support
+- [ ] Options to sort by: name,version,size,mtime,ctime
+- [ ] Finish adding icons
+- [ ] Need to add "plain" icons
+- [ ] Clean up the html output, it is very messy but very awesome!
+- [ ] Add XML output format support
+- [ ] Add YAML output format support
+- [ ] Add TOML output format support (Toml support partially added, but needs a lot of work)
+- [ ] Add a Directory only option
+- [ ] Add a `--no-report` option to disable the report at the end of the output
+- [ ] Add a `--file-limit` option to limit the number of files displayed in the output
+- [ ] Add symbolic link following support
+- [ ] Finish adding output replacement support (where content in between tags is replaced with the output of the command)
+- [ ] Improve how outputs are structured (to minimize the amount of places where things need to be updated to add new output formats)