Skip to content

This tool interactively generates the full structure of a Python project, creating folders, files, modules, and dependencies based on a guided questionnaire. It identifies project type (SAP, RPA, Scraping, ETL, API, AI, CLI), interface options, data sources, and optional automated tests.

Notifications You must be signed in to change notification settings

brunocdpereira/py-pjt-boilerplate-gen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 

Repository files navigation

Automated Python Project Generator

A fully interactive tool that automatically generates the complete structure of a Python project.
It creates folders, modules, starter files, utilities, and even optional test suites - all based on your choices during a guided setup. Created by Bruno Pereira


πŸš€ Features

  • Interactive triage to determine project type:
    • SAP Automation
    • Desktop RPA (PyAutoGUI)
    • Web Scraping
    • ETL / Data Engineering
    • API (FastAPI / Flask)
    • AI / Computer Vision
    • CLI Tools
  • Optional interface setup:
    • No interface
    • Desktop GUI (Tkinter / PySimpleGUI)
    • Web apps (Streamlit / Dash / Gradio)
  • Automatic creation of:
    • Folder structure (src, utils, data, tests)
    • Starter modules for each project type
    • .env file
    • requirements.txt
    • README.md
    • Main entry point (src/main.py)
  • Includes basic templates with functional skeleton code.
  • Ensures consistent project organization and rapid development kickoff.

Installation

pip install <package-name>


Replace <package-name> with the name chosen for your PyPI distribution.

 Usage

Run the generator from the terminal:

python -m project_generator


Or directly:

python main.py


You will be guided through:

Project type

Interface options

Data source

Test suite setup

The tool will then generate a ready-to-use directory:

projeto_python/
│── src/
│── utils/
│── data/
│── tests/   (optional)
│── requirements.txt
│── README.md
│── .env

πŸ—‚ Example Output Structure
projeto_python/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ api/
β”‚   β”œβ”€β”€ etl/
β”‚   β”œβ”€β”€ rpa/
β”‚   β”œβ”€β”€ scraping/
β”‚   β”œβ”€β”€ ai/
β”‚   β”œβ”€β”€ gui/
β”‚   β”œβ”€β”€ webapp/
β”‚   └── main.py
β”œβ”€β”€ utils/
β”œβ”€β”€ data/
β”œβ”€β”€ tests/ (optional)
β”œβ”€β”€ requirements.txt
β”œβ”€β”€ README.md
└── .env

πŸ›  Requirements

Python 3.8+

Windows, Linux, or macOS

 Tests

If enabled during triage, a tests/test_main.py file is created:

def test_example():
    assert True


Run tests with:

pytest

 Contributing

Contributions are welcome!
Feel free to submit issues or open pull requests.

 License

MIT License - free for personal and commercial use.

About

This tool interactively generates the full structure of a Python project, creating folders, files, modules, and dependencies based on a guided questionnaire. It identifies project type (SAP, RPA, Scraping, ETL, API, AI, CLI), interface options, data sources, and optional automated tests.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages