Metadata-Version: 2.4
Name: wirepy
Version: 0.2.5
Summary: WirePy is built on top of FastAPI with the core goal of maintaining large Python backends developed by multiple team members using a standardized project structure. It comes with built-in database connectivity and integrated Alembic migrations. Core components such as models, controllers, services, and schemas are already organized and ready to use. Instead of spending time setting up the project structure, you can simply install it via `pip` and start coding right away.
Author-email: Pradipta Bhuin <bhuinjohn@gmail.com>
License-Expression: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi
Requires-Dist: uvicorn
Requires-Dist: sqlalchemy
Requires-Dist: pymysql
Requires-Dist: python-dotenv
Requires-Dist: alembic
Requires-Dist: click
Requires-Dist: pydantic[email]
Dynamic: license-file

<!-- Logo -->
<p align="center">
  <img src="https://raw.githubusercontent.com/pd-25/cm-live/master/wirepy.svg" alt="Wirepy Logo" />
</p>

# Wirepy

Wirepy is a Python project scaffolding tool designed to accelerate the development of FastAPI-based applications. It provides a command-line interface (CLI) to generate boilerplate code, manage migrations, and organize your project structure following best practices.

## Features
- **CLI Tooling**: Easily scaffold new FastAPI projects and components.
- **Project Templates**: Predefined templates for controllers, models, routes, schemas, services, and core utilities.
- **Database Integration**: Built-in support for database configuration and migrations using Alembic.
- **Environment Management**: Template for `.env` and requirements management.

## Folder Structure

```
── wirepy/
     ├── app/
     │   ├── controllers/
     │   ├── models/
     │   ├── routes/
     │   ├── schemas/
     │   ├── services/
     │   └── core/
     │       ├── config.py
     │       └── database.py
     ├── __init__.py
     ├── alembic/
     ├── alembic.ini
     ├── main.py
     ├── .env
     ├── requirements.txt
     └── README.md
```

## Installation

1. **Create a virtual environment:**
   ```sh
   python3 -m venv venv
   source venv/bin/activate
   ```
2. **Install Wirepy:**
   ```sh
   pip install wirepy
   ```
3. **Create a new project:**
   ```sh
   wirepy new <project-name>
   ```

<!-- ## Getting Started

1. **Clone the repository:**
   ```sh
   git clone <repo-url>
   cd wirepy
   ```
2. **Create a virtual environment:**
   ```sh
   python3 -m venv vvenv
   source vvenv/bin/activate
   ```
3. **Install dependencies:**
   ```sh
   pip install -r wirepy/templates/requirements.txt
   ```
4. **Use the CLI to scaffold a new project or component:**
   ```sh
   python -m wirepy.cli <command> -->
   ```

## License

This project is licensed under the terms of the MIT License. See the `LICENSE` file for details.
