# Treescriptify-Text
Convert a File containing Tree-like information into TreeScript!
## How To Use
Run the main script with a file name as the first positional argument.
`treescriptify-text <file-name>`
The output is printed to standard out (displayed in the command line output).
#### What you can do with this
1. Pipe the output to a file.
2. Copy the output and paste it where you need to.
3. Look at it to get a clear picture of your directory tree.
## How To Install
You can manually install a release (if you want), or use pip.
`pip install treescriptify-text`
## Types of Valid Input
This will work on commonly encountered tree-like text, such as that produced by the tree command.
It doesn't do anything special to decode the input.
- Infers depth in the tree using the amount of indentation before the file name
- Infers parent directory from depth
### Additional Considerations
If a name in the tree does not contain a file extension, and there is no slash character, it may still be treated as a directory.
### Issues and Contributions
If you encounter a tree-like input that is reasonable and should be handled correctly but isn't, please provide the tree-like input in a new issue.
To improve the speed of resolving your issue, provide one or more test cases that demonstrate the failure. Use the existing test cases as a baseline for how to structure your tests.
### Most Importantly
Enjoy using Treescriptify-Text and feel good every time that it works for you.
Raw data
{
"_id": null,
"home_page": "https://github.com/DK96-OS/treescriptify-text",
"name": "treescriptify-text",
"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/fa/e8/67e8340a7226c153589dff46b89c86ffa7fb9cd7fe7d1bd64af54d19e5ae/treescriptify_text-0.3.1.tar.gz",
"platform": null,
"description": "# Treescriptify-Text\nConvert a File containing Tree-like information into TreeScript!\n\n## How To Use\nRun the main script with a file name as the first positional argument.\n\n`treescriptify-text <file-name>`\n\nThe output is printed to standard out (displayed in the command line output).\n\n#### What you can do with this\n1. Pipe the output to a file.\n2. Copy the output and paste it where you need to.\n3. Look at it to get a clear picture of your directory tree.\n\n## How To Install\nYou can manually install a release (if you want), or use pip.\n\n`pip install treescriptify-text`\n\n## Types of Valid Input\nThis will work on commonly encountered tree-like text, such as that produced by the tree command.\n\nIt doesn't do anything special to decode the input.\n- Infers depth in the tree using the amount of indentation before the file name\n- Infers parent directory from depth\n\n### Additional Considerations\nIf a name in the tree does not contain a file extension, and there is no slash character, it may still be treated as a directory.\n\n### Issues and Contributions\nIf you encounter a tree-like input that is reasonable and should be handled correctly but isn't, please provide the tree-like input in a new issue.\n\nTo improve the speed of resolving your issue, provide one or more test cases that demonstrate the failure. Use the existing test cases as a baseline for how to structure your tests.\n\n### Most Importantly\nEnjoy using Treescriptify-Text and feel good every time that it works for you.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Create TreeScript from a Text file that contains tree-like file information.",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/DK96-OS/treescriptify-text",
"Issues": "https://github.com/DK96-OS/treescriptify-text/issues",
"Source Code": "https://github.com/DK96-OS/treescriptify-text"
},
"split_keywords": [
"treescript"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "115615eebb44f4cb284dcfc04aabdda6ebb98e04841218e2d15137eb05fba0fd",
"md5": "b673bcd077212997d05f23b76a6512ba",
"sha256": "4821e48eed9a533d79374851264c020eaa72ec7496b4a4721fde5c58c25ae5e2"
},
"downloads": -1,
"filename": "treescriptify_text-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b673bcd077212997d05f23b76a6512ba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19264,
"upload_time": "2024-12-24T19:08:19",
"upload_time_iso_8601": "2024-12-24T19:08:19.881740Z",
"url": "https://files.pythonhosted.org/packages/11/56/15eebb44f4cb284dcfc04aabdda6ebb98e04841218e2d15137eb05fba0fd/treescriptify_text-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fae867e8340a7226c153589dff46b89c86ffa7fb9cd7fe7d1bd64af54d19e5ae",
"md5": "d14b1eaf96a354d29f191dd9ebba77c1",
"sha256": "04cb97df7998898443c055af08056a56f77edd5d4178da9c344ad0585db5c572"
},
"downloads": -1,
"filename": "treescriptify_text-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "d14b1eaf96a354d29f191dd9ebba77c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19718,
"upload_time": "2024-12-24T19:08:22",
"upload_time_iso_8601": "2024-12-24T19:08:22.281843Z",
"url": "https://files.pythonhosted.org/packages/fa/e8/67e8340a7226c153589dff46b89c86ffa7fb9cd7fe7d1bd64af54d19e5ae/treescriptify_text-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-24 19:08:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DK96-OS",
"github_project": "treescriptify-text",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "treescriptify-text"
}
JSON
