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-1.0.0.tar.gz (11.3 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-1.0.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: structura_py-1.0.0.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.3 Linux/6.8.0-1021-azure

File hashes

Hashes for structura_py-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4cf2f369f0dc84f369584096236472c47b626f4595b00b609ed50aa3dda06bf7
MD5 7a446885bee6a2a7761f692f636f364b
BLAKE2b-256 21d1eae0810736375177bdfcb884b81f6c4b726d34a2039b6c8dcfd9300627ce

See more details on using hashes here.

File details

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

File metadata

  • Download URL: structura_py-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.3 Linux/6.8.0-1021-azure

File hashes

Hashes for structura_py-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 388de56ff24e546427641dbdfabf83f94e3163d587829581a5110c54e8c5d5d0
MD5 91c1f574387af2b9f39b3fe8ef6f16f4
BLAKE2b-256 9aec74b4cedc8f3a7a96a2955465dd8b1a41000e6bde4a97a7f375616605b44d

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