# TreeScript Files
`treescript-files` is a command-line tool built in Python designed to interpret a unique file format known as "treescript." This format is used to describe file and folder directory structures. The primary function of `treescript-files` is to parse a treescript file and output a comprehensive list of file paths defined within the script to the standard output. An optional parameter allows users to prefix all file paths with a specified parent directory, enhancing the tool's flexibility in various file management tasks.
## Features
- **Parse Treescript**: Efficiently reads and processes treescript files.
- **Output File Paths**: Prints the complete list of file paths from the treescript.
- **Directory Prefixing**: Optional addition of a parent directory to all file paths.
## Installation
To install `treescript-files`, you will need Python installed on your system. The tool can be installed directly via pip:
```bash
pip install treescript-files
```
Alternatively, you can clone this repository and install the tool manually:
```bash
git clone https://github.com/yourusername/treescript-files.git
cd treescript-files
python setup.py install
```
## Usage
To use `treescript-files`, run the following command in your terminal:
```bash
treescript-files <path_to_treescript_file>
```
### Options
- **--parent `<directory>`**: Prefixes all output file paths with the specified directory.
### Example
Given a `treescript` file named `example.treescript`, you can display the file paths as follows:
```bash
treescript-files example.treescript
```
To prefix the paths with a parent directory `src/`:
```bash
treescript-files --parent src/ example.treescript
```
## Contributing
Contributions to `treescript-files` are welcome!
## License
`treescript-files` is open-source software licensed under the GPLv3 License. See the `LICENSE` file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/DK96-OS/treescript-files/",
"name": "treescript-files",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "DK96-OS",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/bc/41/0420d47d78a1645f47ec01627148c737e79c3b41da38d76b88fca136fa89/treescript_files-0.2.1.tar.gz",
"platform": null,
"description": "# TreeScript Files\n`treescript-files` is a command-line tool built in Python designed to interpret a unique file format known as \"treescript.\" This format is used to describe file and folder directory structures. The primary function of `treescript-files` is to parse a treescript file and output a comprehensive list of file paths defined within the script to the standard output. An optional parameter allows users to prefix all file paths with a specified parent directory, enhancing the tool's flexibility in various file management tasks.\n\n## Features\n- **Parse Treescript**: Efficiently reads and processes treescript files.\n- **Output File Paths**: Prints the complete list of file paths from the treescript.\n- **Directory Prefixing**: Optional addition of a parent directory to all file paths.\n\n## Installation\nTo install `treescript-files`, you will need Python installed on your system. The tool can be installed directly via pip:\n\n```bash\npip install treescript-files\n```\n\nAlternatively, you can clone this repository and install the tool manually:\n\n```bash\ngit clone https://github.com/yourusername/treescript-files.git\ncd treescript-files\npython setup.py install\n```\n\n## Usage\nTo use `treescript-files`, run the following command in your terminal:\n\n```bash\ntreescript-files <path_to_treescript_file>\n```\n\n### Options\n- **--parent `<directory>`**: Prefixes all output file paths with the specified directory.\n\n### Example\nGiven a `treescript` file named `example.treescript`, you can display the file paths as follows:\n\n```bash\ntreescript-files example.treescript\n```\n\nTo prefix the paths with a parent directory `src/`:\n\n```bash\ntreescript-files --parent src/ example.treescript\n```\n\n## Contributing\nContributions to `treescript-files` are welcome!\n\n## License\n`treescript-files` is open-source software licensed under the GPLv3 License. See the `LICENSE` file for more details.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Obtains the relative path of all files in the TreeScript.",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/DK96-OS/treescript-files/",
"Issues": "https://github.com/DK96-OS/treescript-files/issues",
"Source Code": "https://github.com/DK96-OS/treescript-files/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e38a6882f1ede2bc0e8413a061c0de96d4e22e0a05f39d36fbf3865093c961e9",
"md5": "e2507e56352ba3662d0ebd26c8a140df",
"sha256": "1e7bb8ec7a37b8b948dd3f2fa9d0dd8deaabaea5bfad01ee6657a4c2b1d6465b"
},
"downloads": -1,
"filename": "treescript_files-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e2507e56352ba3662d0ebd26c8a140df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23657,
"upload_time": "2024-12-24T18:09:54",
"upload_time_iso_8601": "2024-12-24T18:09:54.163794Z",
"url": "https://files.pythonhosted.org/packages/e3/8a/6882f1ede2bc0e8413a061c0de96d4e22e0a05f39d36fbf3865093c961e9/treescript_files-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bc410420d47d78a1645f47ec01627148c737e79c3b41da38d76b88fca136fa89",
"md5": "451768ac21c53ce233e9074ea5fe8dc3",
"sha256": "34d0c7ea2914fde9ee77b8e3b9958ca1c6714af1d07503a5f2b851492fa9cec4"
},
"downloads": -1,
"filename": "treescript_files-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "451768ac21c53ce233e9074ea5fe8dc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23282,
"upload_time": "2024-12-24T18:09:55",
"upload_time_iso_8601": "2024-12-24T18:09:55.437836Z",
"url": "https://files.pythonhosted.org/packages/bc/41/0420d47d78a1645f47ec01627148c737e79c3b41da38d76b88fca136fa89/treescript_files-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-24 18:09:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DK96-OS",
"github_project": "treescript-files",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "treescript-files"
}
JSON
