Metadata-Version: 2.4
Name: treescriptify
Version: 0.2.1
Summary: Create TreeScript from an existing filesystem tree.
Home-page: https://github.com/DK96-OS/treescriptify
Author: DK96-OS
License: GPLv2
Project-URL: Issues, https://github.com/DK96-OS/treescriptify/issues
Project-URL: Source Code, https://github.com/DK96-OS/treescriptify
Keywords: treescript
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-python
Dynamic: summary

# Treescriptify
Get Started fast with TreeScript generated from an existing directory.

## How To Use
Run the main script in a directory to treescript-ify it.

1. Pipe program output to a file, or
2. Display it on-screen for copy-paste workflow integration.

## How To Install
You can manually install a release (if you want), or use pip.

`pip install treescriptify`

## Program Architecture
The following diagram shows how the program components work together to process the data.
![tsfy](https://github.com/DK96-OS/tsfy/assets/69859316/84f127f0-cf19-418b-be78-572fbb96868c)

Note: All source modules are contained in the treescriptify package. The input package is merely symbolic in this diagram.
