| Name | prft JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | None |
| Summary | A tool to generate a file tree structure of a project with .gitignore support |
| upload_time | 2024-11-23 13:56:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License |
| keywords |
file
tree
structure
file tree
file structure
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Project File Tree (prft)
prft is a Python library designed to easily generate and display the file structure of a project, with support for .gitignore patterns. It allows you to quickly visualize the organization of files and directories within a specified project directory.
## Features
- Generates a clear and visual representation of your project’s file structure.
- Supports .gitignore and other ignore files, so you only see files relevant to the project.
- Allows hiding hidden files (dotfiles) for a cleaner output.
- Easy to use for ChatGPT.
## Installation
Install prft via pip:
```bash
pip install prft
```
## Usage
Use prft in the terminal to display a project’s file structure.
**Basic Command**
```bash
prft path_to_project
```
You can also use . to specify the current directory if you are in the project directory:
```bash
prft .
```
### Options
- **--no-ignore**: Show all files, including those listed in .gitignore.
- **--no-dot**: Include hidden files (dotfiles) in the output.
- **--prefix** "some prefix": Use your own prefix (" " by default)
**Example:**
```bash
prft path_to_project --no-ignore --no-dot
```
### Example Output
Running prft in a sample project directory might produce output like this:
```
project/
├── src/
│ ├── main.py
│ ├── utils.py
│ └── config/
│ └── settings.py
├── .gitignore
├── README.md
└── requirements.txt
```
This output shows a hierarchical view of the files and directories in *path_to_project*, ignoring files specified in .gitignore (unless `--no-ignore` is used).
## License
This project is licensed under the MIT License.
## Author
Created by [trum-ok](https://github.com/Trum-ok) :p
Raw data
{
"_id": null,
"home_page": null,
"name": "prft",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Arkadii Artamonov <artamarkan@gmail.com>",
"keywords": "file, tree, structure, file tree, file structure",
"author": null,
"author_email": "Arkadii Artamonov <artamarkan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/08/88/ac6374a526e4a7886a2d7f821ae2f079548585cfc5f948ad1c014a39525e/prft-1.3.0.tar.gz",
"platform": null,
"description": "# Project File Tree (prft)\n\nprft is a Python library designed to easily generate and display the file structure of a project, with support for .gitignore patterns. It allows you to quickly visualize the organization of files and directories within a specified project directory.\n\n## Features\n-\tGenerates a clear and visual representation of your project\u2019s file structure.\n-\tSupports .gitignore and other ignore files, so you only see files relevant to the project.\n-\tAllows hiding hidden files (dotfiles) for a cleaner output.\n- Easy to use for ChatGPT.\n\n## Installation\nInstall prft via pip:\n```bash\npip install prft\n```\n\n## Usage\nUse prft in the terminal to display a project\u2019s file structure.\n\n**Basic Command**\n```bash\nprft path_to_project\n```\n\nYou can also use . to specify the current directory if you are in the project directory:\n\n```bash\nprft .\n```\n\n### Options\n- **--no-ignore**: Show all files, including those listed in .gitignore.\n- **--no-dot**: Include hidden files (dotfiles) in the output.\n- **--prefix** \"some prefix\": Use your own prefix (\" \" by default)\n\n**Example:**\n```bash\nprft path_to_project --no-ignore --no-dot\n```\n\n### Example Output\n\nRunning prft in a sample project directory might produce output like this:\n```\nproject/\n\u251c\u2500\u2500 src/\n\u2502 \u251c\u2500\u2500 main.py\n\u2502 \u251c\u2500\u2500 utils.py\n\u2502 \u2514\u2500\u2500 config/\n\u2502 \u2514\u2500\u2500 settings.py\n\u251c\u2500\u2500 .gitignore\n\u251c\u2500\u2500 README.md\n\u2514\u2500\u2500 requirements.txt\n```\nThis output shows a hierarchical view of the files and directories in *path_to_project*, ignoring files specified in .gitignore (unless `--no-ignore` is used).\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Author\n\nCreated by [trum-ok](https://github.com/Trum-ok) :p\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A tool to generate a file tree structure of a project with .gitignore support",
"version": "1.3.0",
"project_urls": null,
"split_keywords": [
"file",
" tree",
" structure",
" file tree",
" file structure"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7e5d6077e819c6e070ab52dde8c8a24fc783f56afc9300d3802cf1f8c7f40ab8",
"md5": "519859919c40ab17f9decc6e1212923c",
"sha256": "bdd6e697925e5eff77a3eda0162ef8a9f802e52e55e429676c4c75241485e456"
},
"downloads": -1,
"filename": "prft-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "519859919c40ab17f9decc6e1212923c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4625,
"upload_time": "2024-11-23T13:56:01",
"upload_time_iso_8601": "2024-11-23T13:56:01.986607Z",
"url": "https://files.pythonhosted.org/packages/7e/5d/6077e819c6e070ab52dde8c8a24fc783f56afc9300d3802cf1f8c7f40ab8/prft-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0888ac6374a526e4a7886a2d7f821ae2f079548585cfc5f948ad1c014a39525e",
"md5": "a00e2a0ed7d49aa6f58f2e7aeb86501e",
"sha256": "ee958d362e0202e660944b000b8b801f5812f5e1ddbd9f057a9bbb7baa5b5351"
},
"downloads": -1,
"filename": "prft-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "a00e2a0ed7d49aa6f58f2e7aeb86501e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4126,
"upload_time": "2024-11-23T13:56:03",
"upload_time_iso_8601": "2024-11-23T13:56:03.295317Z",
"url": "https://files.pythonhosted.org/packages/08/88/ac6374a526e4a7886a2d7f821ae2f079548585cfc5f948ad1c014a39525e/prft-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 13:56:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "prft"
}
