# 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": ">=3.10",
"maintainer_email": null,
"keywords": "treescript",
"author": "DK96-OS",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/40/77/1447d05452cb03ed80fdf903309bf9a5d906e82cd67402b0425d9c58f570/treescript_files-0.2.4.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.4",
"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": [
"treescript"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b3d110dd4c09134eeff48b23d98de430979b7a7a758af0ca8f4e309ee8f6ba84",
"md5": "1a2161702f3bb5e1c096ddbbf4725976",
"sha256": "dc377b15f309ffa8e91dcbb8db77477279b5802c051af04dfb4334a78f61d5ed"
},
"downloads": -1,
"filename": "treescript_files-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a2161702f3bb5e1c096ddbbf4725976",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24412,
"upload_time": "2025-08-13T13:51:52",
"upload_time_iso_8601": "2025-08-13T13:51:52.500201Z",
"url": "https://files.pythonhosted.org/packages/b3/d1/10dd4c09134eeff48b23d98de430979b7a7a758af0ca8f4e309ee8f6ba84/treescript_files-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "40771447d05452cb03ed80fdf903309bf9a5d906e82cd67402b0425d9c58f570",
"md5": "563f5e65eacd76c912b65eb5132a7e71",
"sha256": "41d48c5d532fbbfbf582dd7278854d7f27c1e2e9bd28809d109639ce432f7b44"
},
"downloads": -1,
"filename": "treescript_files-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "563f5e65eacd76c912b65eb5132a7e71",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 24425,
"upload_time": "2025-08-13T13:51:53",
"upload_time_iso_8601": "2025-08-13T13:51:53.633123Z",
"url": "https://files.pythonhosted.org/packages/40/77/1447d05452cb03ed80fdf903309bf9a5d906e82cd67402b0425d9c58f570/treescript_files-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-13 13:51:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DK96-OS",
"github_project": "treescript-files",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "treescript-files"
}
JSON
