Skip to main content

project-tree

A small, dependency-free Python CLI util that prints a recursive tree structure of a project – like a lightweight tree with sensible Python-flavoerd defaults.

Features

  • Recursively prints tree of any given directory.
  • Ignores __pycache__, .venv*, .idea*, .env, .env.*, .env-*, .git, *.pyc, *.pyo, *.pyd by default.
  • -i / --ignore to add extra ignored files/folders (space- or comma-separated).
  • -e / --excludefile [FILE] to load a .gitignore-like file with extra patterns.
  • -s / --size to include human-readable file sizes.
  • -o / --output [FILE] to write the output to custom path (project-tree.txt by default).

Installation

From PyPi (once published):

pip install project-tree-cli

From GitHub

pip install git+https://github.com/VanirSama/project-tree-cli.git

Usage

CLI-command usage example Description
project-tree-cli Tree of current directory.
project-tree-cli .\my-project Tree of .\my-project
project-tree-cli -s Tree with files size displayed
project-tree-cli -i dist
project-tree -i dist docs *.tmp
project-tree -i dist,docs,*.tmp
Add ignored files/folders
(either space- or comma- separated sequences work equally fine)
project-tree-cli -e exclude.txt Load patterns from .gitignore-like file.
project-tree-cli -o
project-tree -o .\tree\output.txt
Write output tree into custom file or into project-tree.txt by default.

Example output

project-tree-cli -s -i tests -o

src/
└── project_tree/
    ├── __init__.py  (86B)
    ├── __main__.py  (132B)
    ├── cli.py  (3.5KB)
    ├── core.py  (4.6KB)
    └── utils.py  (665B)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Metadata

Release files for project-tree-cli 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for project-tree-cli 0.1.0
File Size Uploaded Provenance
project_tree_cli-0.1.0.tar.gz 7.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for project-tree-cli 0.1.0
File Interpreter ABI Platform
project_tree_cli-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 16.0 kB

Release files / project_tree_cli-0.1.0.tar.gz

Download URL project_tree_cli-0.1.0.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
e91fed92b33a2c740d3e7ed4fa7663fa53a07d83406b26ec81f5b0b1fa59d024
BLAKE2b-256 checksum
How to use checksums
0cdf1f6e4580f35e6d5edfb1477aa910fdbd3d5f63505e9383878be3e533c633
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.0

Release files / project_tree_cli-0.1.0-py3-none-any.whl

Download URL project_tree_cli-0.1.0-py3-none-any.whl
Size 8.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
76f9d5bea56222c4ecf903dd5b153b973a01be9bb2d2c599dec54f3dfb7c2bd9
BLAKE2b-256 checksum
How to use checksums
92002e0ea7c9e0fa23b44ec71b63881f71fe34372a3880fed3d892601c0235ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.0

Security for project-tree-cli 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page