Create project folder structures from tree-format files
Project description
tree2project
Create complete project directory structures from tree-format text files.
tree2project allows developers, DevOps engineers, and AI agents to quickly scaffold projects using a simple tree representation.
Installation
pip install tree2project
Features
- Create project structures from tree files
- Export existing project structures
- Validate generated structures
- Dry-run support
- Interactive target directory selection
- Cross-platform
- Lightweight and dependency-friendly
Example Structure File
gitops-agent/
├── pyproject.toml
├── README.md
├── src/
│ ├── main.py
│ └── utils/
│ └── helpers.py
└── tests/
Create Project Structure
tree2project create structure.txt
Specify target directory:
tree2project create structure.txt --target ~/projects
Preview without creating files:
tree2project create structure.txt --dry-run
Export Existing Structure
Export project structure:
tree2project export ./my_project
Save output:
tree2project export ./my_project --output structure.txt
Validate Structure
Validate project against a structure specification:
tree2project validate structure.txt --target ./my_project
Example output:
Structure valid
or
Missing paths:
./my_project/src/main.py
Usage Examples
Generate New Project
tree2project create project_structure.txt
Export Existing Repository
tree2project export ./repository
Verify Generated Project
tree2project validate project_structure.txt --target ./repository
Supported Format
Example:
project/
├── README.md
├── src/
│ ├── main.py
│ └── utils.py
├── tests/
└── requirements.txt
Use Cases
AI Coding Agents
Generate repository skeletons before code generation.
Project Bootstrapping
Create standard project layouts instantly.
Development Teams
Share project templates across teams.
Education
Create exercises and sample projects.
Roadmap
v0.2.0
- JSON support
- YAML support
- Structure diff command
- Template generation
v0.3.0
- Automatic
__init__.py - GitHub repository templates
- Framework templates
v1.0.0
- Plugin system
- Interactive TUI
- Advanced validation engine
Development
Clone repository:
git clone https://github.com/dineshkumarummaneni/tree2project
Install locally:
pip install -e .
Run tests:
pytest
License
MIT License
PyPI
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tree2project-0.1.1.tar.gz.
File metadata
- Download URL: tree2project-0.1.1.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
234fbf9b0eb2455cd14388a42cc6a8a6f800947f9c8c40abe4e2177ea38259e0
|
|
| MD5 |
4bc61bb641437a7b96651ab1f830d834
|
|
| BLAKE2b-256 |
3784792762032f5cf0fd72c7f6272a50a3ebf9584315e8b74d15b07062f54ad2
|
File details
Details for the file tree2project-0.1.1-py3-none-any.whl.
File metadata
- Download URL: tree2project-0.1.1-py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
37f8ce6e1300d4c01f99f3161c5115cc44154fbdfd3c855220f55733e2261cb5
|
|
| MD5 |
2681909d99a2f257fbeb265ca85cf235
|
|
| BLAKE2b-256 |
bc2445b04e463e3ee48ace508a15151bccaf396fa63707e3fc9f661accfc2b42
|