Structify

Structify is a Python-based command-line tool that generates a project directory structure based on a simple text file. It provides a convenient way to create consistent and organized project structures for software development projects.

Structify.mp4

Features

• Create project structures from a simple text-based configuration file
• Supports nested directories and files
• Automatically creates the specified directory structure in the desired output location

Installation

Clone this repository and navigate to the project directory:

git clone https://github.com/808Kamalesh/structify.git
cd structify

Install dependencies

pip install -r requirements.txt

Usage

To generate a project structure, provide a structure file as an argument:

python structify.py <structure_file> --output <output_directory>

Example

python structify.py my_structure.txt --output ./my_project

Structure File Format

Make your structure in a text file with indented lines representing directory. For example: my_structure.txt should look like-

MyProjectRoot
    src/
        main.py
        utils/
            helper.py
    README.md
    .gitignore

Output

D:\Structify>python structify.py my_structure.txt --output ./my_project

░█▀▀░▀█▀░█▀▄░█░█░█▀▀░▀█▀░▀█▀░█▀▀░█░█
░▀▀█░░█░░█▀▄░█░█░█░░░░█░░░█░░█▀▀░░█░
░▀▀▀░░▀░░▀░▀░▀▀▀░▀▀▀░░▀░░▀▀▀░▀░░░░▀░

Output directory: D:\Structify\my_project\MyProjectRoot

Structure File Content:
╭────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ MyProjectRoot                                                                                                                      │
│     src/                                                                                                                           │
│         main.py                                                                                                                    │
│         utils/                                                                                                                     │
│             helper.py                                                                                                              │
│     README.md                                                                                                                      │
│     .gitignore                                                                                                                     │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
  Creating project structure... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100%

✨ Project structure created successfully!

Created Project Structure:
MyProjectRoot
└── MyProjectRoot
    ├── .gitignore
    ├── README.md
    └── src
        ├── main.py
        └── utils
            └── helper.py

  Project Statistics   
┏━━━━━━━━━━━━━┳━━━━━━━┓
┃ Type        ┃ Count ┃
┡━━━━━━━━━━━━━╇━━━━━━━┩
│ Files       │ 4     │
│ Directories │ 3     │
│ Total Items │ 7     │
└─────────────┴───────┘

Author : 808Kamalesh