directory-tree-printer 0.4.1__tar.gz

directory_tree_printer-0.4.1/.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    name: Build, Release and Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+
+      - name: Install package and development dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Verify distributions
+        run: python -m twine check dist/*
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

directory_tree_printer-0.4.1/.github/workflows/tests.yml

@@ -0,0 +1,35 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+
+      - name: Install package and development dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest

directory_tree_printer-0.4.1/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+test-env
+final-test-env
+
+# 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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

directory_tree_printer-0.4.1/CHANGELOG.md

@@ -0,0 +1,56 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/).
+
+---
+
+## [0.3.0] - 2026-05-13
+
+### Added
+- Initial public release of **Tree Printer**
+- Directory tree generation from the command line
+- Optional file and directory icons (`--icons`)
+- Sorting support (`--sort name | size | modified`)
+- File metadata display (size and modified time)
+- File and directory exclusion options
+
+### Changed
+- Designed a modular architecture consisting of `printer`, `formatter`, `icons`, and `cli` modules
+- Improved CLI help and overall user experience
+- Created a clean and extensible formatter design
+
+### Documentation
+- Added a comprehensive README
+- Added usage examples
+- Added a complete CLI options reference
+- Added preview output examples
+
+---
+
+## [0.3.1] - 2026-05-14
+
+### Added
+- Added the `--version` (`-v`) command to display the current Tree Printer version
+
+### Changed
+- Improved package metadata
+- Improved installation behavior
+
+---
+
+## [0.4.0] - 2026-07-03
+
+### Added
+- Comprehensive test suite using **pytest**
+- Automated Continuous Integration (CI) using **GitHub Actions**
+- Automated testing across supported Python versions
+- Improved project metadata for PyPI
+- Added project URLs, keywords, and classifiers to package metadata
+
+### Changed
+- Modernized packaging configuration
+- Improved development workflow
+- Enhanced project documentation
+- Updated the project to follow modern Python packaging best practices

directory_tree_printer-0.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Amirmasoud
+
+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.

directory_tree_printer-0.4.1/PKG-INFO

@@ -0,0 +1,340 @@
+Metadata-Version: 2.4
+Name: directory-tree-printer
+Version: 0.4.1
+Summary: A Python CLI tool for generating clean directory tree structures.
+Author: AmirmasoudCS
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/AmirmasoudCS/Tree-Printer
+Project-URL: Repository, https://github.com/AmirmasoudCS/Tree-Printer
+Project-URL: Issues, https://github.com/AmirmasoudCS/Tree-Printer/issues
+Keywords: tree,cli,directory,filesystem,terminal
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pathspec
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: setuptools-scm[toml]>=8; extra == "dev"
+Dynamic: license-file
+
+
+# 🌲 Tree Printer
+
+[![GitHub Release](https://img.shields.io/github/v/release/AmirmasoudCS/Tree-Printer)](https://github.com/AmirmasoudCS/Tree-Printer/releases)
+[![Tests](https://github.com/AmirmasoudCS/Tree-Printer/actions/workflows/tests.yml/badge.svg)](https://github.com/AmirmasoudCS/Tree-Printer/actions/workflows/tests.yml)
+[![License](https://img.shields.io/github/license/AmirmasoudCS/Tree-Printer)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/)
+
+A lightweight and customizable command-line utility for generating beautiful directory tree structures directly from your terminal.
+
+Tree Printer makes it easy to visualize project layouts, document repositories, create examples for documentation, and inspect filesystem structures with optional icons, metadata, filtering, sorting, and color themes.
+
+---
+
+## ✨ Features
+
+- 🌳 Generate recursive directory trees
+- 📁 Display directories only
+- 👁️ Show or hide hidden files
+- 🚫 Exclude files, directories, or file extensions
+- 📏 Limit recursion depth
+- 🔤 Sort entries by:
+  - Name
+  - Size
+  - Last modified date
+- 📊 Display file size
+- 🕒 Display modification timestamps
+- 🎨 Multiple color themes
+- 🖼️ Optional file and folder icons
+- 📝 Export output to text files
+- 🚫 Respect `.gitignore`
+- ⚡ Fast and lightweight
+- 🧪 Fully tested with pytest
+- 🔄 Continuous Integration using GitHub Actions
+
+---
+
+## 📦 Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install directory-tree-printer
+````
+
+### From source
+
+```bash
+git clone https://github.com/AmirmasoudCS/Tree-Printer.git
+
+cd Tree-Printer
+
+pip install .
+```
+
+---
+
+## 🚀 Quick Start
+
+Print the current directory
+
+```bash
+tp .
+```
+
+Print another directory
+
+```bash
+tp path/to/project
+```
+
+Print only directories
+
+```bash
+tp --dirs-only
+```
+
+Show icons
+
+```bash
+tp --icons
+```
+
+Show file sizes
+
+```bash
+tp --size
+```
+
+Limit depth
+
+```bash
+tp --max-depth 2
+```
+
+Save output
+
+```bash
+tp --output tree.txt
+```
+
+---
+
+## 📖 Examples
+
+### Basic
+
+```bash
+tp .
+```
+
+```text
+project
+├── src
+│   ├── main.py
+│   └── utils.py
+├── README.md
+└── pyproject.toml
+```
+
+---
+
+### Icons
+
+```bash
+tp --icons
+```
+
+```text
+📁 project
+├── 📁 src
+│   ├── 🐍 main.py
+│   └── 🐍 utils.py
+├── 📘 README.md
+└── ⚙️ pyproject.toml
+```
+
+---
+
+### File Sizes
+
+```bash
+tp --size
+```
+
+```text
+README.md (5.8 KB)
+main.py (4.2 KB)
+config.py (831 B)
+```
+
+---
+
+### Modified Dates
+
+```bash
+tp --modified
+```
+
+```text
+README.md (2026-05-12 18:42)
+main.py (2026-05-11 14:30)
+```
+
+---
+
+### Themes
+
+```bash
+tp --theme sunset
+```
+
+![Sunset Theme](images/themeImage1.png)
+
+---
+
+## ⚙️ CLI Options
+
+| Option               | Alias | Description                         |
+| -------------------- | ----- | ----------------------------------- |
+| `--max-depth`        | `-md` | Limit recursion depth               |
+| `--show-hidden`      | `-sh` | Include hidden files                |
+| `--dirs-only`        | `-do` | Show only directories               |
+| `--exclude-dirs`     | `-ed` | Exclude directories                 |
+| `--exclude-files`    | `-ef` | Exclude files                       |
+| `--exclude-suffixes` | `-es` | Exclude file extensions             |
+| `--sort`             | `-st` | Sort by name, size or modified      |
+| `--size`             | `-s`  | Display file sizes                  |
+| `--modified`         | `-m`  | Display modified dates              |
+| `--icons`            | `-i`  | Display icons                       |
+| `--theme`            | `-th` | Select a color theme                |
+| `--no-color`         | `-nc` | Disable colored output              |
+| `--gitignore`        | `-gi` | Ignore files listed in `.gitignore` |
+| `--output`           | `-o`  | Write output to a file              |
+| `--version`          | `-v`  | Show installed version              |
+
+---
+
+## 🧪 Development
+
+Clone the repository
+
+```bash
+git clone https://github.com/AmirmasoudCS/Tree-Printer.git
+```
+
+Install development dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+Run the test suite
+
+```bash
+pytest
+```
+
+Run tests with coverage
+
+```bash
+pytest --cov=tree_printer --cov-report=term-missing
+```
+
+Build the package
+
+```bash
+python -m build
+```
+
+Verify the package
+
+```bash
+python -m twine check dist/*
+```
+
+---
+
+## 📂 Project Structure
+
+```text
+ 
+├── 📁 images
+│   └── 🖼️ themeImage1.png
+├── 📁 tests
+│   ├── 🐍 __init__.py
+│   ├── 🐍 test_cli.py
+│   ├── 🐍 test_formatter.py
+│   └── 🐍 test_printer.py
+├── 📁 tree_printer
+│   ├── 🐍 __init__.py
+│   ├── 🐍 cli.py
+│   ├── 🐍 config.py
+│   ├── 🐍 file_types.py
+│   ├── 🐍 formatter.py
+│   ├── 🐍 icons.py
+│   ├── 🐍 models.py
+│   ├── 🐍 printer.py
+│   └── 🐍 themes.py
+├── 📘 CHANGELOG.md
+├── ⚖️ LICENSE
+├── 🐍 main.py
+├── ⚙️ pyproject.toml
+├── 📘 README.md
+└── 📝 requirements-dev.txt
+```
+
+---
+
+## 🛣️ Roadmap
+
+Future improvements include:
+
+* Additional export formats
+* Custom icon packs
+* More color themes
+* Configuration file support
+* Improved Windows terminal support
+* Performance improvements for very large directories
+
+Suggestions and pull requests are always welcome.
+
+---
+
+## 🤝 Contributing
+
+Contributions, feature requests, and bug reports are welcome.
+
+If you'd like to contribute:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run the test suite
+5. Submit a Pull Request
+
+---
+
+## 📜 Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.
+
+---
+
+## ⚖️ License
+
+This project is licensed under the MIT License.
+
+See [LICENSE](LICENSE) for details.
+
+---