Skip to main content

A tiny tool to print a clean directory tree.

Project description

Lorax

Lorax speaks for the trees: it prints a clean directory tree for your project, excluding heavy / generated directories like virtual environments, build artifacts, and caches — useful for project overviews in a README.md.

Installation

pip install lorax-tree

Usage

from lorax import Lorax

lorax = Lorax(".")
lorax.speak()

This prints a tree for the current working directory, for example:

Lorax/
├── .git/
├── .venv/
├── src/
│   └── lorax/
│       ├── __init__.py
│       ├── __main__.py
│       └── lorax.py
├── .gitignore
├── LICENSE
├── pyproject.toml
└── README.md

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

lorax_tree-0.1.0.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

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

lorax_tree-0.1.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file lorax_tree-0.1.0.tar.gz.

File metadata

  • Download URL: lorax_tree-0.1.0.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for lorax_tree-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d0d917518639bb817d14a1b1b06e4985f015080139dba644cd91423241dcebd7
MD5 5a28fb2a2635da8a62cb4c73311fd308
BLAKE2b-256 4c8ae9f7378bee6a436f59c7add77f52abf25dce539cfae79daf4d6f246711bf

See more details on using hashes here.

File details

Details for the file lorax_tree-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: lorax_tree-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for lorax_tree-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1815cf3a576b054ab7ce1a8fdfea5dd2248d0be9221d89f6343b7ac9410dbc6f
MD5 eb795c3e68557c774952e1a40a225870
BLAKE2b-256 97f73ad7fac8f629e2c82ba14c5284b3d448586440d1252607ef70503e7dab3e

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