Skip to main content

Structura is a CLI tool that automates folder structure generation and dependency management for Python projects. It supports multiple architectures (MVC, MVCS, Hexagonal) and frameworks (Flask, FastAPI), using YAML configuration for flexibility.

Project description

Structura

Automated Folder Structure & Dependency Management for Python Projects


Overview

Structura is a powerful project scaffolding tool designed to automate the creation of consistent and standardized folder structures for Python projects. It supports multiple frameworks and architectures, making it easy to initialize production-ready projects with just a few commands.

Whether you're building a Flask or FastAPI project, Structura handles:

  • Folder structuring
  • Dependency installation
  • Environment setup
  • Custom configurations via YAML

Features

  • Multiple Architectures: MVC, MVCS, Hexagonal, and more
  • Auto-Generates Folders & Boilerplate Files
  • Dependency Management: Supports venv, pipenv, and poetry
  • YAML Configuration for flexible project initialization
  • Extensible: Easily customize folder structures and dependencies
  • Cross-Platform Compatibility: Works on Windows, Linux, and macOS

Installation

You can install Structura using pip:

pip install structura-py

Usage

Initialize a New Project

Create a new Python project with the desired architecture:

structura init myproject --framework flask

For FastAPI:

structura init myproject --framework fastapi

Generate Project Files

If you already have a project, you can simply generate the structure:

structura init

Folder Structure Example

When you run structura-py init, it generates the following folder structure based on the chosen architecture (e.g., MVC):

/myproject
├── app
│   ├── __init__.py
│   ├── models
│   │   └── user.py
│   ├── services
│   │   └── user_service.py
│   ├── controllers
│   │   └── user_controller.py
│   ├── routes
│   │   └── user_routes.py
├── config
│   ├── settings.py
│   └── config.yaml
├── tests
│   ├── test_user.py
├── requirements.txt
├── .env
├── README.md
└── main.py

Architecture Variations:

  • MVC: models, services, controllers, routes
  • MVCS: Adds services layer for business logic separation
  • Hexagonal: Adds adapters and ports folders for dependency inversion

Contributing

We welcome contributions!
To contribute:

  1. Fork the repository
  2. Create a new feature branch
  3. Commit your changes
  4. Open a Pull Request (PR)

License

Structura is licensed under the MIT License.
Feel free to use, modify, and distribute it.


Feedback & Issues

If you encounter any issues or have suggestions, feel free to open an issue on GitHub.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

structura_py-0.1.2.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

structura_py-0.1.2-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file structura_py-0.1.2.tar.gz.

File metadata

  • Download URL: structura_py-0.1.2.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.11.5 Windows/10

File hashes

Hashes for structura_py-0.1.2.tar.gz
Algorithm Hash digest
SHA256 a504266883081e996ccc8564b2caf3757f7a975fd50aeb51318e674b20548466
MD5 243c9f62a07e31fb861fccbd61e7c1a0
BLAKE2b-256 e993481ae37439872ce2392299d159cf45984eda464b989ab90b8a0e44dd951d

See more details on using hashes here.

File details

Details for the file structura_py-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: structura_py-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.11.5 Windows/10

File hashes

Hashes for structura_py-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7cc7b1b218cc06368bf983e8a26c4a0ae2b47d20f04f7fae71594af97ba75220
MD5 3242e8e8eb8c66205d807ecdb52e1f64
BLAKE2b-256 b04eebba5d1fc4abc36fc6993e02ad625ea809cb0c0064ea917661e1ddf7b757

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page