| Name | pygentree JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | https://github.com/taeefnajib/pygentree |
| Summary | A Python package to generate ASCII tree representation of directory structures |
| upload_time | 2024-10-24 10:23:02 |
| maintainer | None |
| docs_url | None |
| author | Taeef Najib |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2024 Taeef Najib 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
tree
filesystem
ascii
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyGenTree
[](https://pypi.org/project/pygentree/)
[](https://github.com/taeefnajib/pygentree/blob/main/LICENSE)
[](https://pypi.org/project/pygentree/)
A Python package to generate ASCII tree representation of directory structures.
## Requirements
- Python 3.6 or higher
## Installation
```bash
pip install pygentree
```
## Usage
```bash
# Basic usage (current directory)
pygentree
# Specify a directory
pygentree /path/to/directory
# Limit depth level
pygentree -l 2
# Sort files and folders
pygentree -s asc # ascending order
pygentree -s desc # descending order
pygentree -s standard # default: folders first, then files
# Show only directories
pygentree -d
# Ignore hidden files and directories, e.g. .git, .env, etc.
pygentree --ignore-hidden
# Exclude specific files or directories (comma-separated)
pygentree -e "node_modules,venv,dist"
# Save output to file
pygentree -o tree.txt
# Show version
pygentree -v
# Show help
pygentree -h
```
## Features
- Generate ASCII tree representation of directory structures
- Customize maximum depth level
- Multiple sorting options
- Option to show only directories
- Option to ignore hidden files and directories
- Exclude specific files and directories
- Save output to file
- Handle permission errors gracefully
- Cross-platform compatibility
## Supported Python Versions
- Python 3.6
- Python 3.7
- Python 3.8
- Python 3.9
- Python 3.10
- Python 3.11
- Python 3.12
## License
MIT License
Raw data
{
"_id": null,
"home_page": "https://github.com/taeefnajib/pygentree",
"name": "pygentree",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "directory, tree, filesystem, ascii",
"author": "Taeef Najib",
"author_email": "Taeef Najib <taeefnajib@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e5/22/fe113c3d1e50bfcd93847a9347e403f3ae15457bc48fe673aa29fa7db6b2/pygentree-1.0.3.tar.gz",
"platform": null,
"description": "# PyGenTree\n\n[](https://pypi.org/project/pygentree/)\n[](https://github.com/taeefnajib/pygentree/blob/main/LICENSE)\n[](https://pypi.org/project/pygentree/)\n\nA Python package to generate ASCII tree representation of directory structures.\n\n## Requirements\n\n- Python 3.6 or higher\n\n## Installation\n\n```bash\npip install pygentree\n```\n\n## Usage\n\n```bash\n# Basic usage (current directory)\npygentree\n\n# Specify a directory\npygentree /path/to/directory\n\n# Limit depth level\npygentree -l 2\n\n# Sort files and folders\npygentree -s asc # ascending order\npygentree -s desc # descending order\npygentree -s standard # default: folders first, then files\n\n# Show only directories\npygentree -d\n\n# Ignore hidden files and directories, e.g. .git, .env, etc.\npygentree --ignore-hidden\n\n# Exclude specific files or directories (comma-separated)\npygentree -e \"node_modules,venv,dist\"\n\n# Save output to file\npygentree -o tree.txt\n\n# Show version\npygentree -v\n\n# Show help\npygentree -h\n```\n\n## Features\n\n- Generate ASCII tree representation of directory structures\n- Customize maximum depth level\n- Multiple sorting options\n- Option to show only directories\n- Option to ignore hidden files and directories\n- Exclude specific files and directories\n- Save output to file\n- Handle permission errors gracefully\n- Cross-platform compatibility\n\n## Supported Python Versions\n\n- Python 3.6\n- Python 3.7\n- Python 3.8\n- Python 3.9\n- Python 3.10\n- Python 3.11\n- Python 3.12\n\n## License\n\nMIT License\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Taeef Najib 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 Python package to generate ASCII tree representation of directory structures",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/taeefnajib/pygentree"
},
"split_keywords": [
"directory",
" tree",
" filesystem",
" ascii"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d9c186680c237715118a6951350f4302aedbd340bf171539fcf151c802e2b14",
"md5": "420d2abb133063e2ecd560890b011f30",
"sha256": "426e918a2bf0c8f4d1c1aebc47365dad2c0b6fcb732fe18f2d51f6e9f726d4b3"
},
"downloads": -1,
"filename": "pygentree-1.0.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "420d2abb133063e2ecd560890b011f30",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 6702,
"upload_time": "2024-10-24T10:23:01",
"upload_time_iso_8601": "2024-10-24T10:23:01.391579Z",
"url": "https://files.pythonhosted.org/packages/3d/9c/186680c237715118a6951350f4302aedbd340bf171539fcf151c802e2b14/pygentree-1.0.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e522fe113c3d1e50bfcd93847a9347e403f3ae15457bc48fe673aa29fa7db6b2",
"md5": "8d36281e2a7154837a748f0379b22303",
"sha256": "910824e26d8342f409deab3fd80a16875028b3e37d44264f4568e6a86b2c4fd1"
},
"downloads": -1,
"filename": "pygentree-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "8d36281e2a7154837a748f0379b22303",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5576,
"upload_time": "2024-10-24T10:23:02",
"upload_time_iso_8601": "2024-10-24T10:23:02.837231Z",
"url": "https://files.pythonhosted.org/packages/e5/22/fe113c3d1e50bfcd93847a9347e403f3ae15457bc48fe673aa29fa7db6b2/pygentree-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-24 10:23:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "taeefnajib",
"github_project": "pygentree",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pygentree"
}
