Skip to main content

Analyze files and folders fast

Project description

pytree-stats

PRs Welcome

A small Python command-line utility for generating directory tree listings. Use it to inspect folder hierarchies, share file structure snapshots, or compare directory layouts across projects.

screenshot

What the project does

pytree-stats reads a filesystem path and prints a tree-style view of the directory contents. It is designed as a lightweight, easy-to-run Python script that works without complex setup.

Why the project is useful

  • Quickly inspect folder structure from the terminal
  • AI-Friendly: Generates structured output that is easy for LLMs to parse.
  • Useful for documentation, code reviews, and project audits
  • Works cross-platform with Python
  • Simple, no heavy dependencies

Get started

Prerequisites

Installation

  1. Clone the repository:
git clone https://github.com/JohannesL2/pytree-stats.git
cd pytree-stats
  1. Install dependencies using the requirements file:
pip install -r requirements.txt
  1. Run the script
python tree.py

Contributing

Contributions are welcome and greatly appreciated! Here is how you can help:

  1. Look at the open issues labeled good first issue.
  2. Fork the repository and create a new branch for your feature or bugfix.
  3. Open a Pull Request (PR) and describe your changes.

Thanks for helping make pytree-stats better! 🚀

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytree_stats-1.0.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytree_stats-1.0.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file pytree_stats-1.0.0.tar.gz.

File metadata

  • Download URL: pytree_stats-1.0.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for pytree_stats-1.0.0.tar.gz
Algorithm Hash digest
SHA256 17ca7001c6aac103749af93c4b3947ff1501c9fe876f71602c6fa8a02dd0ee80
MD5 49625339e4ce0b14937cd112b43f8f73
BLAKE2b-256 ae7d80a3374ef2677aeb948e393f2ed12c4371ea47d7f523396b9231dad71dd9

See more details on using hashes here.

File details

Details for the file pytree_stats-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pytree_stats-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for pytree_stats-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 89000ab04fab56a7f00628ecc661ec9ff8ddf4bcee9e643c3e42c3110d926789
MD5 831a6c693b1168d4fa4a9665315af8db
BLAKE2b-256 8f1127fa6ce5399713ee9f29ddadffb96dbe558c7b54c253663cacde1c272a6a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page