Metadata-Version: 2.4
Name: treeing
Version: 1.0.1
Summary: ASCII tree → directory/file generator
Author: MING
License-Expression: MIT
Project-URL: Homepage, https://github.com/xiao-ming-b65536/treeing
Project-URL: Source, https://github.com/xiao-ming-b65536/treeing
Project-URL: Issue Tracker, https://github.com/xiao-ming-b65536/treeing/issues
Project-URL: Changelog, https://github.com/xiao-ming-b65536/treeing/blob/main/CHANGELOG.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Treeing — ASCII tree → directory/file generator

Turn directory-tree text (e.g. output from the `tree` command) into real folders and empty files.

## Features

- Common `tree` output formats: Unicode box-drawing, pipe style, Windows `tree`, space-indented trees.
- Automatic indent repair (disable with `--no-fix` or the GUI checkbox).
- Both a GUI and a CLI.
- Cross-platform: Windows, macOS, Linux.
- User-visible strings live in `treeing/strings.json` (bootstrap errors in `treeing/strings.bootstrap.json`).

## Preview

![Treeing GUI](docs/screenshots/gui_en.png)

> Screenshot: Windows, English UI, parsing a sample project tree.

## Quick start

### Install from PyPI

```bash
pip install treeing
treeing -i tree.txt -o ./out   # CLI
treeing-gui                    # GUI
```

The CLI needs only the Python standard library. The GUI uses `tkinter`; on Linux install it with `sudo apt-get install python3-tk` (it ships with Python on Windows and macOS).

### Run from source

```bash
python -m venv .venv
# Windows: .\.venv\Scripts\pip install -r requirements-build.txt
# Unix:    .venv/bin/pip install -r requirements-build.txt

python -m treeing.main                       # GUI
python -m treeing.main -i tree.txt -o ./out  # CLI
python -m treeing.main --help                # CLI help
```

### Run a prebuilt executable

Prebuilt binaries are attached to each [release](https://github.com/xiao-ming-b65536/treeing/releases) (Windows, Linux, macOS ARM, macOS x86). Pick the archive for your platform (replace `vX.Y.Z` with the actual version):

| Platform | Archives |
|---|---|
| Windows | `treeing-cli-windows-vX.Y.Z.zip`, `treeing-gui-windows-vX.Y.Z.zip` |
| Linux | `treeing-cli-linux-vX.Y.Z.tar.gz`, `treeing-gui-linux-vX.Y.Z.tar.gz` |
| macOS (Apple Silicon) | `treeing-cli-macos-arm64-vX.Y.Z.tar.gz`, `treeing-gui-macos-arm64-vX.Y.Z.tar.gz` |
| macOS (Intel) | `treeing-cli-macos-x86_64-vX.Y.Z.tar.gz`, `treeing-gui-macos-x86_64-vX.Y.Z.tar.gz` |

CLI and GUI are packaged separately; download whichever you need. Verify against `SHA256SUMS.txt` in the same release.

```bash
treeing-gui                           # GUI — Linux / macOS
treeing-gui.exe                       # GUI — Windows

treeing-cli -i tree.txt -o ./out      # CLI — Linux / macOS
treeing-cli.exe -i tree.txt -o ./out  # CLI — Windows
treeing-cli --help                    # CLI help — Linux / macOS
treeing-cli.exe --help                # CLI help — Windows
```

### Build executables yourself

```bash
pip install -r requirements-build.txt
python build.py --target all          # outputs to dist/<platform>/
```

## Documentation

See [docs/USER_GUIDE.md](docs/USER_GUIDE.md) for a unified guide covering source runs and prebuilt executables on Windows, macOS ARM, macOS x86, and Linux.

## Legal

- **Licence** — MIT; see [LICENSE](LICENSE).
- **Privacy Policy** — see [PRIVACY.md](PRIVACY.md).
- **Terms of Use** — see [TERMS.md](TERMS.md).

## AI Disclosure

Parts of this source code were written with assistance from AI coding tools.
