fastapi-mongo-setup 0.3.2__tar.gz → 0.4.0__tar.gz

fastapi_mongo_setup-0.4.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: fastapi-mongo-setup
+Version: 0.4.0
+Summary: A CLI tool to auto-generate MongoDB connection boilerplates for FastAPI projects.
+Author-email: Souvik <wbjee.souvik@gmail.com>
+Project-URL: Homepage, https://github.com/Souvik6222/fastapi-mongo-setup
+Project-URL: Issues, https://github.com/Souvik6222/fastapi-mongo-setup/issues
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: motor
+Requires-Dist: python-dotenv
+Requires-Dist: fastapi
+Requires-Dist: pydantic-settings
+
+# fastapi-mongo-setup 🚀
+
+[![PyPI version](https://badge.fury.io/py/fastapi-mongo-setup.svg)](https://badge.fury.io/py/fastapi-mongo-setup)
+[![Python versions](https://img.shields.io/pypi/pyversions/fastapi-mongo-setup.svg)](https://pypi.python.org/pypi/fastapi-mongo-setup)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Stop writing MongoDB boilerplate for FastAPI!**
+`fastapi-mongo-setup` is a fast, lightweight Python CLI tool that instantly scaffolds a professional, industry-standard FastAPI + MongoDB project structure — including an optional **JWT authentication system**.
+
+---
+
+## ⚡ Installation
+
+```bash
+pip install fastapi-mongo-setup
+```
+
+## 🛠️ Usage
+
+### Basic Setup (DB + CRUD)
+Navigate to your project folder and run:
+```bash
+mongo-setup
+```
+
+### With Authentication 🔐
+Add a complete JWT auth system (register, login, protected routes):
+```bash
+mongo-setup --auth
+```
+
+---
+
+## 📁 Generated Project Structure
+
+### Without `--auth`
+```text
+your-project/
+├── .env                   # MONGODB_URL, DATABASE_NAME, PORT
+├── requirements.txt       # fastapi, motor, pydantic-settings, etc.
+├── main.py                # FastAPI entry point with MongoDB lifespan
+└── src/
+    ├── config.py          # Pydantic Settings configuration loader
+    ├── utils/
+    │   ├── db.py          # Async Motor connection manager
+    │   └── helpers.py     # ObjectId serialization helpers
+    └── tasks/
+        ├── router.py      # GET / POST / DELETE endpoints
+        ├── schemas.py     # Pydantic validation models
+        └── service.py     # Database CRUD logic
+```
+
+### With `--auth` (adds these files)
+```text
+└── src/
+    ├── config.py          # Now includes SECRET_KEY, ALGORITHM, etc.
+    └── auth/              # 🔐 Complete Auth Module
+        ├── router.py      # /auth/register, /auth/login, /auth/me
+        ├── schemas.py     # UserCreate, UserLogin, Token models
+        ├── service.py     # Create user, find user by email
+        ├── dependencies.py # JWT creation & verification, get_current_user
+        └── utils.py       # Password hashing with bcrypt
+```
+
+Plus auto-updates to:
+- **`.env`** → adds `SECRET_KEY`, `ALGORITHM`, `ACCESS_TOKEN_EXPIRE_MINUTES`
+- **`requirements.txt`** → adds `python-jose`, `passlib`, `bcrypt`
+- **`main.py`** → registers the auth router automatically
+
+---
+
+## 🚀 Running Your Generated Project
+
+```bash
+# 1. Install dependencies
+pip install -r requirements.txt
+
+# 2. Start the server
+python main.py
+```
+
+Open `http://localhost:8000/docs` to see your Swagger UI with fully functional **Tasks CRUD** and (if `--auth` was used) **Authentication** endpoints!
+
+---
+
+## 🔐 Auth Endpoints (when using `--auth`)
+
+| Method | Endpoint          | Description                    | Auth Required |
+|--------|-------------------|--------------------------------|---------------|
+| POST   | `/auth/register`  | Create a new user account      | ❌            |
+| POST   | `/auth/login`     | Get a JWT access token         | ❌            |
+| GET    | `/auth/me`        | Get current user's profile     | ✅ Bearer     |
+
+---
+
+## 🏗 Why this exists?
+
+Setting up `Motor` (async MongoDB driver) with FastAPI typically requires repetitive boilerplate: connection managers, lifespans, ObjectId serialization, and JWT auth plumbing. This tool does all of that for you in **one command**, providing a clean, modular architecture designed for scaling.
+
+## 🤝 Contributing
+Found a bug or want to request a feature? Feel free to [open an issue](https://github.com/Souvik6222/fastapi-mongo-setup/issues) or submit a pull request!

fastapi_mongo_setup-0.4.0/README.md

@@ -0,0 +1,101 @@
+# fastapi-mongo-setup 🚀
+
+[![PyPI version](https://badge.fury.io/py/fastapi-mongo-setup.svg)](https://badge.fury.io/py/fastapi-mongo-setup)
+[![Python versions](https://img.shields.io/pypi/pyversions/fastapi-mongo-setup.svg)](https://pypi.python.org/pypi/fastapi-mongo-setup)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Stop writing MongoDB boilerplate for FastAPI!**
+`fastapi-mongo-setup` is a fast, lightweight Python CLI tool that instantly scaffolds a professional, industry-standard FastAPI + MongoDB project structure — including an optional **JWT authentication system**.
+
+---
+
+## ⚡ Installation
+
+```bash
+pip install fastapi-mongo-setup
+```
+
+## 🛠️ Usage
+
+### Basic Setup (DB + CRUD)
+Navigate to your project folder and run:
+```bash
+mongo-setup
+```
+
+### With Authentication 🔐
+Add a complete JWT auth system (register, login, protected routes):
+```bash
+mongo-setup --auth
+```
+
+---
+
+## 📁 Generated Project Structure
+
+### Without `--auth`
+```text
+your-project/
+├── .env                   # MONGODB_URL, DATABASE_NAME, PORT
+├── requirements.txt       # fastapi, motor, pydantic-settings, etc.
+├── main.py                # FastAPI entry point with MongoDB lifespan
+└── src/
+    ├── config.py          # Pydantic Settings configuration loader
+    ├── utils/
+    │   ├── db.py          # Async Motor connection manager
+    │   └── helpers.py     # ObjectId serialization helpers
+    └── tasks/
+        ├── router.py      # GET / POST / DELETE endpoints
+        ├── schemas.py     # Pydantic validation models
+        └── service.py     # Database CRUD logic
+```
+
+### With `--auth` (adds these files)
+```text
+└── src/
+    ├── config.py          # Now includes SECRET_KEY, ALGORITHM, etc.
+    └── auth/              # 🔐 Complete Auth Module
+        ├── router.py      # /auth/register, /auth/login, /auth/me
+        ├── schemas.py     # UserCreate, UserLogin, Token models
+        ├── service.py     # Create user, find user by email
+        ├── dependencies.py # JWT creation & verification, get_current_user
+        └── utils.py       # Password hashing with bcrypt
+```
+
+Plus auto-updates to:
+- **`.env`** → adds `SECRET_KEY`, `ALGORITHM`, `ACCESS_TOKEN_EXPIRE_MINUTES`
+- **`requirements.txt`** → adds `python-jose`, `passlib`, `bcrypt`
+- **`main.py`** → registers the auth router automatically
+
+---
+
+## 🚀 Running Your Generated Project
+
+```bash
+# 1. Install dependencies
+pip install -r requirements.txt
+
+# 2. Start the server
+python main.py
+```
+
+Open `http://localhost:8000/docs` to see your Swagger UI with fully functional **Tasks CRUD** and (if `--auth` was used) **Authentication** endpoints!
+
+---
+
+## 🔐 Auth Endpoints (when using `--auth`)
+
+| Method | Endpoint          | Description                    | Auth Required |
+|--------|-------------------|--------------------------------|---------------|
+| POST   | `/auth/register`  | Create a new user account      | ❌            |
+| POST   | `/auth/login`     | Get a JWT access token         | ❌            |
+| GET    | `/auth/me`        | Get current user's profile     | ✅ Bearer     |
+
+---
+
+## 🏗 Why this exists?
+
+Setting up `Motor` (async MongoDB driver) with FastAPI typically requires repetitive boilerplate: connection managers, lifespans, ObjectId serialization, and JWT auth plumbing. This tool does all of that for you in **one command**, providing a clean, modular architecture designed for scaling.
+
+## 🤝 Contributing
+Found a bug or want to request a feature? Feel free to [open an issue](https://github.com/Souvik6222/fastapi-mongo-setup/issues) or submit a pull request!

{fastapi_mongo_setup-0.3.2 → fastapi_mongo_setup-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-mongo-setup"
-version = "0.3.2"
+version = "0.4.0"
 description = "A CLI tool to auto-generate MongoDB connection boilerplates for FastAPI projects."
 authors = [
     {name = "Souvik", email = "wbjee.souvik@gmail.com"},

fastapi_mongo_setup-0.4.0/src/auth/dependencies.py

@@ -0,0 +1,35 @@
+from datetime import datetime, timedelta
+from jose import JWTError, jwt
+from fastapi import Depends, HTTPException, status
+from fastapi.security import OAuth2PasswordBearer
+from src.config import settings
+from src.auth.service import AuthService
+from src.utils.helpers import serialize_doc
+
+oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/login")
+
+def create_access_token(data: dict) -> str:
+    """Create a JWT access token with an expiration time."""
+    to_encode = data.copy()
+    expire = datetime.utcnow() + timedelta(minutes=settings.access_token_expire_minutes)
+    to_encode.update({"exp": expire})
+    return jwt.encode(to_encode, settings.secret_key, algorithm=settings.algorithm)
+
+async def get_current_user(token: str = Depends(oauth2_scheme)):
+    """Decode the JWT token and return the current user from the database."""
+    credentials_exception = HTTPException(
+        status_code=status.HTTP_401_UNAUTHORIZED,
+        detail="Could not validate credentials",
+        headers={"WWW-Authenticate": "Bearer"},
+    )
+    try:
+        payload = jwt.decode(token, settings.secret_key, algorithms=[settings.algorithm])
+        email: str = payload.get("sub")
+        if email is None:
+            raise credentials_exception
+    except JWTError:
+        raise credentials_exception
+    user = await AuthService.get_user_by_email(email)
+    if user is None:
+        raise credentials_exception
+    return serialize_doc(user)

fastapi_mongo_setup-0.4.0/src/auth/router.py

@@ -0,0 +1,32 @@
+from fastapi import APIRouter, HTTPException, Depends
+from src.auth.schemas import UserCreate, UserLogin, UserResponse, Token
+from src.auth.service import AuthService
+from src.auth.dependencies import create_access_token, get_current_user
+from src.auth.utils import verify_password
+
+router = APIRouter(prefix="/auth", tags=["Authentication"])
+
+@router.post("/register", response_model=UserResponse)
+async def register(user: UserCreate):
+    """Register a new user account."""
+    existing_user = await AuthService.get_user_by_email(user.email)
+    if existing_user:
+        raise HTTPException(status_code=400, detail="Email already registered")
+    created_user = await AuthService.create_user(user.model_dump())
+    return created_user
+
+@router.post("/login", response_model=Token)
+async def login(user: UserLogin):
+    """Authenticate user and return a JWT access token."""
+    db_user = await AuthService.get_user_by_email(user.email)
+    if not db_user:
+        raise HTTPException(status_code=401, detail="Invalid credentials")
+    if not verify_password(user.password, db_user["password"]):
+        raise HTTPException(status_code=401, detail="Invalid credentials")
+    access_token = create_access_token(data={"sub": db_user["email"]})
+    return {"access_token": access_token, "token_type": "bearer"}
+
+@router.get("/me", response_model=UserResponse)
+async def get_me(current_user: dict = Depends(get_current_user)):
+    """Get the profile of the currently authenticated user."""
+    return current_user

fastapi_mongo_setup-0.4.0/src/auth/schemas.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel, Field
+
+class UserCreate(BaseModel):
+    name: str = Field(..., example="John Doe")
+    email: str = Field(..., example="john@example.com")
+    password: str = Field(..., min_length=6, example="secret123")
+
+class UserLogin(BaseModel):
+    email: str = Field(..., example="john@example.com")
+    password: str = Field(..., example="secret123")
+
+class UserResponse(BaseModel):
+    id: str
+    name: str
+    email: str
+
+class Token(BaseModel):
+    access_token: str
+    token_type: str = "bearer"

fastapi_mongo_setup-0.4.0/src/auth/service.py

@@ -0,0 +1,22 @@
+from src.utils.db import db
+from src.utils.helpers import serialize_doc
+from src.auth.utils import hash_password
+
+class AuthService:
+    @staticmethod
+    def get_collection():
+        return db.db["users"]
+
+    @staticmethod
+    async def create_user(user_data: dict) -> dict:
+        """Hash password and insert user into the database."""
+        user_data["password"] = hash_password(user_data["password"])
+        result = await AuthService.get_collection().insert_one(user_data)
+        created_user = await AuthService.get_collection().find_one({"_id": result.inserted_id})
+        return serialize_doc(created_user)
+
+    @staticmethod
+    async def get_user_by_email(email: str):
+        """Find a user document by email address."""
+        user = await AuthService.get_collection().find_one({"email": email})
+        return user

fastapi_mongo_setup-0.4.0/src/auth/utils.py

@@ -0,0 +1,11 @@
+from passlib.context import CryptContext
+
+pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
+
+def hash_password(password: str) -> str:
+    """Hash a plain-text password using bcrypt."""
+    return pwd_context.hash(password)
+
+def verify_password(plain_password: str, hashed_password: str) -> bool:
+    """Verify a plain-text password against its hash."""
+    return pwd_context.verify(plain_password, hashed_password)

fastapi_mongo_setup-0.4.0/src/fastapi_mongo_setup.egg-info/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: fastapi-mongo-setup
+Version: 0.4.0
+Summary: A CLI tool to auto-generate MongoDB connection boilerplates for FastAPI projects.
+Author-email: Souvik <wbjee.souvik@gmail.com>
+Project-URL: Homepage, https://github.com/Souvik6222/fastapi-mongo-setup
+Project-URL: Issues, https://github.com/Souvik6222/fastapi-mongo-setup/issues
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: motor
+Requires-Dist: python-dotenv
+Requires-Dist: fastapi
+Requires-Dist: pydantic-settings
+
+# fastapi-mongo-setup 🚀
+
+[![PyPI version](https://badge.fury.io/py/fastapi-mongo-setup.svg)](https://badge.fury.io/py/fastapi-mongo-setup)
+[![Python versions](https://img.shields.io/pypi/pyversions/fastapi-mongo-setup.svg)](https://pypi.python.org/pypi/fastapi-mongo-setup)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Stop writing MongoDB boilerplate for FastAPI!**
+`fastapi-mongo-setup` is a fast, lightweight Python CLI tool that instantly scaffolds a professional, industry-standard FastAPI + MongoDB project structure — including an optional **JWT authentication system**.
+
+---
+
+## ⚡ Installation
+
+```bash
+pip install fastapi-mongo-setup
+```
+
+## 🛠️ Usage
+
+### Basic Setup (DB + CRUD)
+Navigate to your project folder and run:
+```bash
+mongo-setup
+```
+
+### With Authentication 🔐
+Add a complete JWT auth system (register, login, protected routes):
+```bash
+mongo-setup --auth
+```
+
+---
+
+## 📁 Generated Project Structure
+
+### Without `--auth`
+```text
+your-project/
+├── .env                   # MONGODB_URL, DATABASE_NAME, PORT
+├── requirements.txt       # fastapi, motor, pydantic-settings, etc.
+├── main.py                # FastAPI entry point with MongoDB lifespan
+└── src/
+    ├── config.py          # Pydantic Settings configuration loader
+    ├── utils/
+    │   ├── db.py          # Async Motor connection manager
+    │   └── helpers.py     # ObjectId serialization helpers
+    └── tasks/
+        ├── router.py      # GET / POST / DELETE endpoints
+        ├── schemas.py     # Pydantic validation models
+        └── service.py     # Database CRUD logic
+```
+
+### With `--auth` (adds these files)
+```text
+└── src/
+    ├── config.py          # Now includes SECRET_KEY, ALGORITHM, etc.
+    └── auth/              # 🔐 Complete Auth Module
+        ├── router.py      # /auth/register, /auth/login, /auth/me
+        ├── schemas.py     # UserCreate, UserLogin, Token models
+        ├── service.py     # Create user, find user by email
+        ├── dependencies.py # JWT creation & verification, get_current_user
+        └── utils.py       # Password hashing with bcrypt
+```
+
+Plus auto-updates to:
+- **`.env`** → adds `SECRET_KEY`, `ALGORITHM`, `ACCESS_TOKEN_EXPIRE_MINUTES`
+- **`requirements.txt`** → adds `python-jose`, `passlib`, `bcrypt`
+- **`main.py`** → registers the auth router automatically
+
+---
+
+## 🚀 Running Your Generated Project
+
+```bash
+# 1. Install dependencies
+pip install -r requirements.txt
+
+# 2. Start the server
+python main.py
+```
+
+Open `http://localhost:8000/docs` to see your Swagger UI with fully functional **Tasks CRUD** and (if `--auth` was used) **Authentication** endpoints!
+
+---
+
+## 🔐 Auth Endpoints (when using `--auth`)
+
+| Method | Endpoint          | Description                    | Auth Required |
+|--------|-------------------|--------------------------------|---------------|
+| POST   | `/auth/register`  | Create a new user account      | ❌            |
+| POST   | `/auth/login`     | Get a JWT access token         | ❌            |
+| GET    | `/auth/me`        | Get current user's profile     | ✅ Bearer     |
+
+---
+
+## 🏗 Why this exists?
+
+Setting up `Motor` (async MongoDB driver) with FastAPI typically requires repetitive boilerplate: connection managers, lifespans, ObjectId serialization, and JWT auth plumbing. This tool does all of that for you in **one command**, providing a clean, modular architecture designed for scaling.
+
+## 🤝 Contributing
+Found a bug or want to request a feature? Feel free to [open an issue](https://github.com/Souvik6222/fastapi-mongo-setup/issues) or submit a pull request!

{fastapi_mongo_setup-0.3.2 → fastapi_mongo_setup-0.4.0}/src/fastapi_mongo_setup.egg-info/SOURCES.txt

@@ -1,5 +1,11 @@
 README.md
 pyproject.toml
+src/auth/__init__.py
+src/auth/dependencies.py
+src/auth/router.py
+src/auth/schemas.py
+src/auth/service.py
+src/auth/utils.py
 src/fastapi_mongo_setup.egg-info/PKG-INFO
 src/fastapi_mongo_setup.egg-info/SOURCES.txt
 src/fastapi_mongo_setup.egg-info/dependency_links.txt

{fastapi_mongo_setup-0.3.2 → fastapi_mongo_setup-0.4.0}/src/fastapi_mongo_setup.egg-info/top_level.txt

@@ -1,3 +1,4 @@
+auth
 mongo_setup
 tasks
 utils