# Project File Tree JSON (prft-json)
Modified version of the [prft](https://github.com/Trum-ok/project-file-tree) for use primarily in the RAG LLM.
## Installation
Install prft-json via pip:
```bash
pip install prft-json
```
## Usage
Use prft in the terminal to display a project’s file structure.
**Basic Command**
```bash
prft-json path_to_project
```
You can also use . to specify the current directory if you are in the project directory:
```bash
prft-json .
```
## Options
- **--no-ignore** Include files and directories that would otherwise be ignored based on patterns in .gitignore. By default, files and directories matching .gitignore patterns are excluded.
- **--no-dot** Include hidden files and directories (those starting with a dot .). By default, dotfiles and dotfolders are excluded unless explicitly listed in the .gitignore file.
- **--prefix** `<string>` Specify a prefix for the tree structure output. This option is primarily for visual representation and formatting purposes. The default is a single space (' ').
- **--output-name** `<filename>` Specify the name of the output JSON file. The default filename is result.json. You do not need to include the .json extension, as it will be added automatically.
**Example:**
```bash
prft-json path_to_project --no-ignore --no-dot
```
### Example Output
```json
[
{
"prft_json": [
"__init__.py",
"prft.py"
]
},
".gitignore",
"LICENSE",
"README.md",
"pyproject.toml"
]
```
## 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-json",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Arkadii Artamonov <artamarkan@gmail.com>",
"keywords": "file, tree, structure, file tree, file structure, json file tree",
"author": null,
"author_email": "Arkadii Artamonov <artamarkan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e9/15/3568bdf7a9ca656b527d863d0dad0c60c66a5942b649b0c41bb7d033dbf3/prft_json-1.0.0.tar.gz",
"platform": null,
"description": "# Project File Tree JSON (prft-json)\nModified version of the [prft](https://github.com/Trum-ok/project-file-tree) for use primarily in the RAG LLM.\n\n## Installation\nInstall prft-json via pip:\n```bash\npip install prft-json\n```\n\n## Usage\nUse prft in the terminal to display a project\u2019s file structure.\n\n**Basic Command**\n```bash\nprft-json 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-json .\n```\n\n## Options\n- **--no-ignore** Include files and directories that would otherwise be ignored based on patterns in .gitignore. By default, files and directories matching .gitignore patterns are excluded.\n- **--no-dot** Include hidden files and directories (those starting with a dot .). By default, dotfiles and dotfolders are excluded unless explicitly listed in the .gitignore file.\n- **--prefix** `<string>` Specify a prefix for the tree structure output. This option is primarily for visual representation and formatting purposes. The default is a single space (' ').\n- **--output-name** `<filename>` Specify the name of the output JSON file. The default filename is result.json. You do not need to include the .json extension, as it will be added automatically.\n\n\n**Example:**\n```bash\nprft-json path_to_project --no-ignore --no-dot\n```\n\n### Example Output\n```json\n[\n {\n \"prft_json\": [\n \"__init__.py\",\n \"prft.py\"\n ]\n },\n \".gitignore\",\n \"LICENSE\",\n \"README.md\",\n \"pyproject.toml\"\n]\n```\n\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 json file tree structure of a project with .gitignore support",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"file",
" tree",
" structure",
" file tree",
" file structure",
" json file tree"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7909be5dc2168c4d201a0dac634a1339c0293ca58d0da87370c348c0cd06f9d0",
"md5": "821e0b6e22cb7f2ad8aa05901cb1c625",
"sha256": "5e44e4789c4537ffd1cbdf6935e444b81fb306dd5edf12d88b23074a6358514b"
},
"downloads": -1,
"filename": "prft_json-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "821e0b6e22cb7f2ad8aa05901cb1c625",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5138,
"upload_time": "2024-12-06T06:36:05",
"upload_time_iso_8601": "2024-12-06T06:36:05.862863Z",
"url": "https://files.pythonhosted.org/packages/79/09/be5dc2168c4d201a0dac634a1339c0293ca58d0da87370c348c0cd06f9d0/prft_json-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e9153568bdf7a9ca656b527d863d0dad0c60c66a5942b649b0c41bb7d033dbf3",
"md5": "1c45d6471d5bd812c89967b7616a55ff",
"sha256": "9be6a17549d58df1d69160fe3ae5361a6e573b949f45af1cc27b522e7453535c"
},
"downloads": -1,
"filename": "prft_json-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1c45d6471d5bd812c89967b7616a55ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4555,
"upload_time": "2024-12-06T06:36:08",
"upload_time_iso_8601": "2024-12-06T06:36:08.491706Z",
"url": "https://files.pythonhosted.org/packages/e9/15/3568bdf7a9ca656b527d863d0dad0c60c66a5942b649b0c41bb7d033dbf3/prft_json-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 06:36:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "prft-json"
}
JSON