| Name | directree JSON |
| Version |
0.9
JSON |
| download |
| home_page | None |
| Summary | A CLI tool to generate a customizable directory tree while ignoring specified files and folders. |
| upload_time | 2024-11-05 08:43:10 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Directree
**Directree** is a command-line tool for generating a customizable directory tree of your projects while ignoring unimportant files and folders. It is designed to help developers visualize their project structures in a clean and organized manner.
## Features
- **Customizable Ignoring**: Specify project types (frontend, backend, machine learning) to automatically ignore common unimportant files and folders.
- **User Input**: Allows users to specify additional files and folders to ignore, tailoring the output to their specific needs.
- **Recursive Directory Traversal**: Generates a tree structure that reflects the actual organization of files and directories.
- **Cross-Platform Compatibility**: Works seamlessly on Windows, macOS, and Linux.
## Installation
To install Directree, you can use pip:
```bash
pip install directree
```
## Usage
Once installed, you can run the tool directly from your command line:
## Step-by-Step Instructions:
- **Project Type**: Specify the type of your project (e.g., frontend, backend, ml, or skip).
- **Additional Folders**: Optionally, provide a list of additional folders to ignore, separated by commas.
- **Additional Files**: Optionally, provide a list of additional files to ignore, separated by commas.
- **Root Directory**: Enter the path of the root directory for which you want to generate the tree. Press enter to use the current directory.
## Example Output
Here's an example of how Directree generates a directory tree:
## Customizing Ignore Patterns
You can customize the files and folders that are ignored based on your project type and specific needs. For example, if your project is a frontend web application, you might want to ignore folders like node_modules, .firebase, and specific files like package-lock.json.
## Acknowledgements
Setuptools - For packaging the project
Twine - For uploading the package to PyPI
Python - The programming language used to create Directree
Raw data
{
"_id": null,
"home_page": null,
"name": "directree",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/59/15/091fc021794789a6671605d58bff6c186a626ab26b5da35c545f3b508ff8/directree-0.9.tar.gz",
"platform": null,
"description": "# Directree\r\n\r\n**Directree** is a command-line tool for generating a customizable directory tree of your projects while ignoring unimportant files and folders. It is designed to help developers visualize their project structures in a clean and organized manner.\r\n\r\n## Features\r\n\r\n- **Customizable Ignoring**: Specify project types (frontend, backend, machine learning) to automatically ignore common unimportant files and folders.\r\n- **User Input**: Allows users to specify additional files and folders to ignore, tailoring the output to their specific needs.\r\n- **Recursive Directory Traversal**: Generates a tree structure that reflects the actual organization of files and directories.\r\n- **Cross-Platform Compatibility**: Works seamlessly on Windows, macOS, and Linux.\r\n\r\n## Installation\r\n\r\nTo install Directree, you can use pip:\r\n\r\n```bash\r\npip install directree\r\n```\r\n\r\n## Usage\r\nOnce installed, you can run the tool directly from your command line:\r\n\r\n\r\n## Step-by-Step Instructions:\r\n- **Project Type**: Specify the type of your project (e.g., frontend, backend, ml, or skip).\r\n- **Additional Folders**: Optionally, provide a list of additional folders to ignore, separated by commas.\r\n- **Additional Files**: Optionally, provide a list of additional files to ignore, separated by commas.\r\n- **Root Directory**: Enter the path of the root directory for which you want to generate the tree. Press enter to use the current directory.\r\n\r\n## Example Output\r\nHere's an example of how Directree generates a directory tree:\r\n\r\n\r\n\r\n## Customizing Ignore Patterns\r\nYou can customize the files and folders that are ignored based on your project type and specific needs. For example, if your project is a frontend web application, you might want to ignore folders like node_modules, .firebase, and specific files like package-lock.json.\r\n\r\n## Acknowledgements\r\nSetuptools - For packaging the project\r\n\r\nTwine - For uploading the package to PyPI\r\n\r\nPython - The programming language used to create Directree\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A CLI tool to generate a customizable directory tree while ignoring specified files and folders.",
"version": "0.9",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "831be6b7ee229903bd60b9849fdcfe585377480a5a6aa8f903427a3e77e92593",
"md5": "6cef97d357a5fe7118e92eed0b5d4ebf",
"sha256": "f3de7ca640cc99f017ceb63edc87d7e5f5a15572402ee1c37011dffa5a8730df"
},
"downloads": -1,
"filename": "directree-0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6cef97d357a5fe7118e92eed0b5d4ebf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3716,
"upload_time": "2024-11-05T08:43:08",
"upload_time_iso_8601": "2024-11-05T08:43:08.550474Z",
"url": "https://files.pythonhosted.org/packages/83/1b/e6b7ee229903bd60b9849fdcfe585377480a5a6aa8f903427a3e77e92593/directree-0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5915091fc021794789a6671605d58bff6c186a626ab26b5da35c545f3b508ff8",
"md5": "fa313b7191448ec67281684a18506f19",
"sha256": "227fb6b5b8c4b30ee4fd7a3df1aa16eb1993ccab2dc1c2a0239b49d8fa6493d0"
},
"downloads": -1,
"filename": "directree-0.9.tar.gz",
"has_sig": false,
"md5_digest": "fa313b7191448ec67281684a18506f19",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3381,
"upload_time": "2024-11-05T08:43:10",
"upload_time_iso_8601": "2024-11-05T08:43:10.139135Z",
"url": "https://files.pythonhosted.org/packages/59/15/091fc021794789a6671605d58bff6c186a626ab26b5da35c545f3b508ff8/directree-0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 08:43:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "directree"
}
