superfast-cli 0.1.1

A CLI tool for generating project files

SuperFast CLI Tool

This CLI tool is designed for generating common file types used in FastAPI projects, such as controllers, models, services, and entities.

Installation

Installation

You can install the CLI tool via pip:

pip install superfast-cli

Usage

Generate files based on file type and class name:

fast create FILE_TYPE CLASS_NAME [--directory DIRECTORY]

Arguments:

• FILE_TYPE - The type of file to generate. Valid values are:
  • controller: Creates a controller file.
  • model: Creates a model file.
  • service: Creates a service file.
  • entity: Creates an entity file.
  • res: Creates all file types (controller, model, service, and entity).
• CLASS_NAME - The name of the class to generate the file for.
• Options: -d, --directory - Directory to create the file in. Default is the current directory.

Example

Controller

Creates a controller.py file in the current location. You can also specify a location:

fast create controller MyController

fast create controller MyController --directory app/category

Generated File: controller.py

from fastapi import APIRouter

router = APIRouter()

@router.get("/")
async def get_items():
    # Implement your logic here
    pass

@router.post("/")
async def create_item():
    # Implement your logic here
    pass

Model

Creates an model.py file:

fast create model Category

fast create model Category --directory app/category

Generated File: model.py

from pydantic import BaseModel

class CategoryModel(BaseModel):
    id: int
    name: str
    description: str

Entity

Creates an entity.py file:

fast create entity Category

fast create entity Category --directory app/category

Generated File: entity.py

# entity.py
from sqlalchemy import Column, Integer, String
from database import Base

class CategoryEntity(Base):
    __tablename__ = "category"

    id = Column(Integer, primary_key=True, index=True, autoincrement=True)
    name = Column(String, index=True)

Service

Creates an service.py file:

fast create Service Category

fast create service Category --directory app/category

Generated File: service.py

# service.py
from sqlalchemy.orm import Session
from fastapi import Depends
from database import get_db


class CategoryService:
    def __init__(self, db: Session):
        self.db = db


def get_category_service(db: Session = Depends(get_db)) -> CategoryService:
    return CategoryService(db=db)

Resource

Creates all file types (controller.py, model.py, service.py, and entity.py):

fast create res Category

fast create res Category --directory app/category

Generated Files

- controller.py
- service.py
- model.py
- entity.py