Metadata-Version: 2.1
Name: treescriptify-text
Version: 0.3
Summary: Create TreeScript from a Text file that contains tree-like file information.
Home-page: https://github.com/DK96-OS/treescriptify-text
Author: DK96-OS
License: GPLv3
Project-URL: Issues, https://github.com/DK96-OS/treescriptify-text/issues
Project-URL: Source Code, https://github.com/DK96-OS/treescriptify-text
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE

# 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.
