| Name | dir-tree-printer JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A simple utility to print directory structures in a tree-like format |
| upload_time | 2025-01-18 10:54:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2025 NAGARAJ.K Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
directory
structure
tree
visualization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Tree Printer
A simple Python library that helps developers generate and share their project directory structures. Perfect for documenting project layouts in GitHub READMEs, technical documentation, or when explaining project organization to other developers.
## Why Tree Printer?
When sharing your project on platforms like GitHub or discussing code organization with other developers, it's important to show your project's folder structure. However, manually typing out directory structures is:
- Time-consuming
- Error-prone
- Hard to maintain as your project grows
Tree Printer solves this by automatically generating a clean, consistent directory structure that you can instantly copy into your documentation.
## Example
Run:
```bash
dir-tree-printer /path/to/your/project
```
Get:
```
└── my-project
├── src
│ └── components
│ ├── Header.js
│ └── Footer.js
├── tests
├── README.md
└── package.json
```
Now you can directly paste this into your README, documentation, or anywhere else you need to show your project structure!
## Installation
```bash
pip install dir-tree-printer
```
## Usage
### Command Line
```bash
# Basic usage
dir-tree-printer /path/to/directory
# Exclude specific folders
dir-tree-printer /path/to/directory --exclude node_modules .git
```
### Python API
```python
from tree_printer import TreePrinter
printer = TreePrinter()
printer.print_structure("./my_directory")
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "dir-tree-printer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "directory, structure, tree, visualization",
"author": null,
"author_email": "Nagaraj K <kbnagaraj18@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e8/9b/3706392aba986ad28533fcca4d91c5958ff987138a2b100e4aa518b0a6f9/dir_tree_printer-0.1.1.tar.gz",
"platform": null,
"description": "# Tree Printer\n\nA simple Python library that helps developers generate and share their project directory structures. Perfect for documenting project layouts in GitHub READMEs, technical documentation, or when explaining project organization to other developers.\n\n## Why Tree Printer?\n\nWhen sharing your project on platforms like GitHub or discussing code organization with other developers, it's important to show your project's folder structure. However, manually typing out directory structures is:\n- Time-consuming\n- Error-prone\n- Hard to maintain as your project grows\n\nTree Printer solves this by automatically generating a clean, consistent directory structure that you can instantly copy into your documentation.\n\n## Example\n\nRun:\n```bash\ndir-tree-printer /path/to/your/project\n```\n\nGet:\n```\n\u2514\u2500\u2500 my-project\n \u251c\u2500\u2500 src\n \u2502 \u2514\u2500\u2500 components\n \u2502 \u251c\u2500\u2500 Header.js\n \u2502 \u2514\u2500\u2500 Footer.js\n \u251c\u2500\u2500 tests\n \u251c\u2500\u2500 README.md\n \u2514\u2500\u2500 package.json\n```\n\nNow you can directly paste this into your README, documentation, or anywhere else you need to show your project structure!\n\n## Installation\n\n```bash\npip install dir-tree-printer\n```\n\n## Usage\n\n### Command Line\n```bash\n# Basic usage\ndir-tree-printer /path/to/directory\n\n# Exclude specific folders\ndir-tree-printer /path/to/directory --exclude node_modules .git\n```\n\n### Python API\n```python\nfrom tree_printer import TreePrinter\n\nprinter = TreePrinter()\nprinter.print_structure(\"./my_directory\")\n```\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 NAGARAJ.K Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A simple utility to print directory structures in a tree-like format",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/NAGARAJ08/tree-printer"
},
"split_keywords": [
"directory",
" structure",
" tree",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a956f13df7fb442445a443f9aa86c1878670b61c04a5006865cd5b94353ba588",
"md5": "3bdb762464ef723a8aeb06608a844ef5",
"sha256": "2ea85158f5a5d76ad9b92058fa6dda086d53f0ed0cba282ee799cb6e338e1b6d"
},
"downloads": -1,
"filename": "dir_tree_printer-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3bdb762464ef723a8aeb06608a844ef5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4973,
"upload_time": "2025-01-18T10:54:18",
"upload_time_iso_8601": "2025-01-18T10:54:18.022757Z",
"url": "https://files.pythonhosted.org/packages/a9/56/f13df7fb442445a443f9aa86c1878670b61c04a5006865cd5b94353ba588/dir_tree_printer-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e89b3706392aba986ad28533fcca4d91c5958ff987138a2b100e4aa518b0a6f9",
"md5": "d57968de1fa9781115c999a035507b71",
"sha256": "92bcd85216e61f731a3f2c3cae0198cd6598dc53814f3e207441588ced427421"
},
"downloads": -1,
"filename": "dir_tree_printer-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "d57968de1fa9781115c999a035507b71",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3832,
"upload_time": "2025-01-18T10:54:20",
"upload_time_iso_8601": "2025-01-18T10:54:20.604731Z",
"url": "https://files.pythonhosted.org/packages/e8/9b/3706392aba986ad28533fcca4d91c5958ff987138a2b100e4aa518b0a6f9/dir_tree_printer-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-18 10:54:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NAGARAJ08",
"github_project": "tree-printer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dir-tree-printer"
}
