Skip to main content

A simple Python script that displays the directory tree of the current working directory with color-coded output for easy file identification.

Project description

Print Pretty Tree

print-pretty-tree is a simple Python script that displays the directory tree of the current working directory with color-coded output for easy file identification.

Installation

To install print-pretty-tree, you can use either pip or other package managers like npm, pnpm, or yarn.

Install using pip

If you have Python and pip installed, you can run the following command:

pip install print-pretty-tree --user

Install using other package managers

# Using npm
npm i -g print-pretty-tree

# Using pnpm
pnpm i -g print-pretty-tree

# Using yarn
yarn global add print-pretty-tree

Usage

Once you have installed print-pretty-tree, you can run the script in any directory.

Using pip installation

If you have installed print-pretty-tree using pip, you can run the following command in any directory:

print-pretty-tree

Using other package managers

If you have installed the JavaScript version of print-pretty-tree using npm, pnpm, or yarn, you can run the following commands in any directory:

# Using npm, pnpm, or yarn
print-pretty-tree

By default, the script excludes certain folders and file patterns like node_modules and .git to make the output more manageable. The script will recursively pretty print the directory structure.

Customization

  • To add more file types and colors to the output, you can modify the FILE_TYPE_COLORS dictionary in the script.
  • You can also customize the excluded file patterns by modifying the EXCLUDED_PATTERNS list in the script.

Contributing

If you find any bugs or want to suggest new features for print-pretty-tree, please feel free to contribute by submitting an issue or a pull request.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

All Contributors

This project follows the all-contributors specification. Contributions of any kind welcome!

License

Licensed under the MIT license. See the LICENSE file for more information.

If you found this project interesting, please consider sponsoring me or following me on twitter twitter

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

print_pretty_tree-0.0.2-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

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