# Print Pretty Tree
a.k.a. `ptree` is a simple Python script that displays the directory tree of the current working directory with color-coded output for easy file identification.
<p align="center">
<img width="460" src="https://i.imgur.com/GSO6vmJ.jpg">
</p>
## 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:
```bash
pip install print-pretty-tree --user
```
### Install using other package managers
If you have `npm` 5.2 or higher, we recommend using `npx` to run packages globally. This way, you don't need to install the package globally and can still use it as a tool.
```bash
npx print-pretty-tree
```
If you still want to install `print-pretty-tree` globally, on the command line, run the following command:
```bash
npm install -g print-pretty-tree
```
If you get an EACCES permissions error, you may need to reinstall `npm` with a version manager or manually change `npm`'s default directory. For more information, see the [npm docs here](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).
## Usage
Once you have installed `print-pretty-tree`, you can run the script in any directory.
> You can run any of the commands below in any directory, regardless of how you installed it.
```bash
pt
ptree
print-pretty-tree
```
The script excludes certain files and folders like node_modules and .git by default to make the output easier to manage. It will recursively display the directory structure in a visually pleasing way.
## 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, please feel free to contribute by submitting an [issue](https://github.com/itsbrex/print-pretty-tree/issues) or a [pull request](https://github.com/itsbrex/print-pretty-tree/pulls).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[](#Contributing)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://allcontributors.org/) specification. Contributions of any kind welcome!
## License
Licensed under the MIT license. See the [LICENSE](./LICENSE) file for more information.
If you found this project interesting or helpful, please consider [sponsoring me](https://github.com/sponsors/itsbrex) or <a href="https://twitter.com/itsbrex">following me on twitter <img src="https://storage.googleapis.com/saasify-assets/twitter-logo.svg" alt="twitter" height="24px" align="center"></a>
Raw data
{
"_id": null,
"home_page": "https://github.com/itsbrex/print-pretty-tree",
"name": "print-pretty-tree",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "directory,tree,pretty-print,file-system,visualization,color-coded,file-identification,command-line,CLI,directory-structure",
"author": "itsbrex",
"author_email": "itsbrexnpm@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4a/da/5f02f4356ece3e1c20efb6928ca5d2060b01d6eb0b329529560e38995b2c/print-pretty-tree-0.0.3.tar.gz",
"platform": null,
"description": "# Print Pretty Tree\n\na.k.a. `ptree` is a simple Python script that displays the directory tree of the current working directory with color-coded output for easy file identification.\n\n<p align=\"center\">\n <img width=\"460\" src=\"https://i.imgur.com/GSO6vmJ.jpg\">\n</p>\n\n## Installation\n\nTo install `print-pretty-tree`, you can use either `pip` or other package managers like `npm`, `pnpm`, or `yarn`.\n\n### Install using pip\n\nIf you have Python and `pip` installed:\n\n```bash\npip install print-pretty-tree --user\n```\n\n### Install using other package managers\n\nIf you have `npm` 5.2 or higher, we recommend using `npx` to run packages globally. This way, you don't need to install the package globally and can still use it as a tool.\n\n```bash\nnpx print-pretty-tree\n```\n\nIf you still want to install `print-pretty-tree` globally, on the command line, run the following command:\n\n```bash\nnpm install -g print-pretty-tree\n```\n\nIf you get an EACCES permissions error, you may need to reinstall `npm` with a version manager or manually change `npm`'s default directory. For more information, see the [npm docs here](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).\n\n## Usage\n\nOnce you have installed `print-pretty-tree`, you can run the script in any directory.\n> You can run any of the commands below in any directory, regardless of how you installed it.\n```bash\npt\n\nptree\n\nprint-pretty-tree\n```\n\nThe script excludes certain files and folders like node_modules and .git by default to make the output easier to manage. It will recursively display the directory structure in a visually pleasing way.\n\n\n\n## Customization\n\n- To add more file types and colors to the output, you can modify the `FILE_TYPE_COLORS` dictionary in the script.\n- You can also customize the excluded file patterns by modifying the `EXCLUDED_PATTERNS` list in the script.\n\n## Contributing\n\nIf you find any bugs or want to suggest new features, please feel free to contribute by submitting an [issue](https://github.com/itsbrex/print-pretty-tree/issues) or a [pull request](https://github.com/itsbrex/print-pretty-tree/pulls).\n\n## Contributors \u2728\nThanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):\n\n<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n[](#Contributing)\n\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\nThis project follows the [all-contributors](https://allcontributors.org/) specification. Contributions of any kind welcome!\n\n## License\n\nLicensed under the MIT license. See the [LICENSE](./LICENSE) file for more information.\n\nIf you found this project interesting or helpful, please consider [sponsoring me](https://github.com/sponsors/itsbrex) or <a href=\"https://twitter.com/itsbrex\">following me on twitter <img src=\"https://storage.googleapis.com/saasify-assets/twitter-logo.svg\" alt=\"twitter\" height=\"24px\" align=\"center\"></a>\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple Python script that displays the directory tree of the current working directory with color-coded output for easy file identification.",
"version": "0.0.3",
"split_keywords": [
"directory",
"tree",
"pretty-print",
"file-system",
"visualization",
"color-coded",
"file-identification",
"command-line",
"cli",
"directory-structure"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8aea67a612933e2c8c88af44b6159b12ded558eb951a7055856d19c16e142afd",
"md5": "1df15f2f60073bb69c0eccc1b542fcbc",
"sha256": "3974c1e453d7dbf921398f2178274beb10f87c32561b33c86849d2d31d0c38b0"
},
"downloads": -1,
"filename": "print_pretty_tree-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1df15f2f60073bb69c0eccc1b542fcbc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3895,
"upload_time": "2023-04-27T01:55:48",
"upload_time_iso_8601": "2023-04-27T01:55:48.578060Z",
"url": "https://files.pythonhosted.org/packages/8a/ea/67a612933e2c8c88af44b6159b12ded558eb951a7055856d19c16e142afd/print_pretty_tree-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ada5f02f4356ece3e1c20efb6928ca5d2060b01d6eb0b329529560e38995b2c",
"md5": "24dd6dee9780166835840cda055e1f53",
"sha256": "0fcb6a95e95e48477be785480c7aa18033558b8cb5d8a462d4e71b735ec0efa2"
},
"downloads": -1,
"filename": "print-pretty-tree-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "24dd6dee9780166835840cda055e1f53",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3760,
"upload_time": "2023-04-27T01:55:50",
"upload_time_iso_8601": "2023-04-27T01:55:50.542491Z",
"url": "https://files.pythonhosted.org/packages/4a/da/5f02f4356ece3e1c20efb6928ca5d2060b01d6eb0b329529560e38995b2c/print-pretty-tree-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-27 01:55:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "itsbrex",
"github_project": "print-pretty-tree",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "setuptools",
"specs": [
[
"==",
"67.6.1"
]
]
}
],
"lcname": "print-pretty-tree"
}
JSON
