nexus-fastapi 0.1.0

A FastAPI project generator and framework

Nexus-FastAPI

A powerful FastAPI project generator and framework that helps you create scalable and maintainable FastAPI applications.

Features

• Automatic project scaffolding
• Database integration with SQLAlchemy
• Automatic table creation
• CRUD operations generation
• API documentation with Swagger UI
• Environment configuration
• Modular application structure

Installation

pip install nexus-fastapi

Usage

Create a new project with default settings:

nexus-fastapi create_project my_api

Create a project with custom configuration:

nexus-fastapi create_project my_api --config config.json

Sample Configuration File (config.json):

{
  "project_name": "my_fastapi_app",
  "description": "A sample FastAPI application",
  "version": "1.0.0",
  "apps": [
    {
      "name": "users",
      "models": [
        {
          "name": "User",
          "fields": [
            {
              "name": "email",
              "type": "string",
              "nullable": false
            },
            {
              "name": "username",
              "type": "string",
              "nullable": false
            }
          ]
        }
      ]
    }
  ]
}

Running the Generated Project

1. Navigate to your project directory:

   cd my_api
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Run the application:

   uvicorn main:app --reload --host 0.0.0.0 --port 8000
   

4. Access the API documentation:

   • Swagger UI: http://localhost:8000/docs
   • ReDoc: http://localhost:8000/redoc

Project Structure

my_api/
├── apps/
│   └── users/
│       ├── __init__.py
│       ├── models.py
│       ├── schemas.py
│       ├── crud.py
│       ├── service.py
│       └── routes.py
├── core/
│   ├── config/
│   │   └── settings.py
│   └── database/
│       └── base.py
├── tests/
├── .env
├── main.py
└── requirements.txt

License

MIT License