Skip to main content

Generate directory tree diagrams for Real Python articles

Project description

RP Tree

RP Tree is a command-line tool to generate directory tree diagrams.

Installation

To install RP Tree, just run the following command:

$ pip install rptree

Usage

$ rptree /path/to/directory/

Note: The -h or --help option provides help on using RP Tree.

Sample Output

$ rptree hello/
./hello/
│
├── hello/
│   ├── __init__.py
│   └── hello.py
│
├── tests/
│   └── test_hello.py
│
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

That's it! You've generated a nice directory tree diagram.

Features

If you run RP Tree with a directory path as an argument, then you get a full directory tree diagram printed on your screen. The default input directory is your current directory.

RP Tree also provides the following options:

  • -v, --version shows the application version and exits
  • -h, --help show a usage message
  • -d, --dir-only generates a directory-only tree diagram
  • -o, --output-file generates a full directory tree diagram and save it to a file in markdown format

Release History

  • 0.1.1
    • Display the entries in alphabetical order
  • 0.1.0
    • A work in progress

About the Author

Leodanis Pozo Ramos - Email: leodanis@realpython.com

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

rptree-0.1.1.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

rptree-0.1.1-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file rptree-0.1.1.tar.gz.

File metadata

  • Download URL: rptree-0.1.1.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/51.1.1 requests-toolbelt/0.8.0 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for rptree-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f475b7287d26de904af2bca6332d3290436acd53e5b4e00271fe91af16e56981
MD5 8c9c5492df9dc4c4c841b5dc31d544f6
BLAKE2b-256 4514d169adde563ab4f4697988546d3b7bbf945626fc73ee57f5a076d7433f25

See more details on using hashes here.

File details

Details for the file rptree-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: rptree-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/51.1.1 requests-toolbelt/0.8.0 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for rptree-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1d82b6021da24b5f9b2962dfb6dce357c271805c71041011433e90af35e3806a
MD5 6f29d135f65b33fb1ca69b199bbe8cd3
BLAKE2b-256 6c8411f50274f650630947725056a7ed8e74a47832f7dcd0502c7184bdf64bb6

See more details on using hashes here.

Supported by

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