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

fastapi_mongo_setup-0.3.2/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: fastapi-mongo-setup
+Version: 0.3.2
+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. It generates async DB connections, Pydantic settings, and a fully functional CRUD router in one command.
+
+---
+
+## ⚡ Installation
+
+Install globally or within your virtual environment:
+
+```bash
+pip install fastapi-mongo-setup
+```
+
+## 🛠️ Usage
+
+Navigate to the root of your empty (or existing) FastAPI project and run:
+
+```bash
+mongo-setup
+```
+
+### What does this command do?
+Instantly, it generates the following modular architecture:
+
+```text
+fastapi-project/
+├── .env                   # Auto-populated with MONGODB_URL and DATABASE_NAME
+├── requirements.txt       # Dependencies (fastapi, motor, pydantic-settings, etc)
+├── main.py                # FastAPI entry point with MongoDB Lifespan logic
+└── src/
+    ├── config.py          # Configuration loader using Pydantic Settings
+    ├── utils/             # Database core
+    │   ├── db.py          # Asynchronous Motor connection manager
+    │   └── helpers.py     # MongoDB ObjectId Serialization helpers
+    └── tasks/             # Complete pre-built API module
+        ├── router.py      # GET/POST/DELETE endpoints
+        ├── schemas.py     # Pydantic validation models
+        └── service.py     # Database CRUD logic
+```
+
+## 🚀 Running Your Generated Project
+
+Once the files are created, just install the dependencies and start the built-in demo server!
+
+```bash
+# 1. Install required packages
+pip install -r requirements.txt
+
+# 2. Run the server
+python main.py
+```
+
+Go to `http://localhost:8000/docs` to see your automatically generated Swagger UI with a fully functional `Tasks` API connected to your MongoDB!
+
+---
+
+## 🏗 Why this exists?
+
+Setting up `Motor` (the async MongoDB driver) with FastAPI usually requires copy-pasting code to handle connections, lifespans, and fixing `ObjectId` serialization errors. This minimalist tool does all of that for you, providing a clean abstraction layer and a modular structure designed for scaling.
+
+## 🤝 Contributing
+Found a bug or want to request a feature? Feel free to open an issue or submit a pull request!

fastapi_mongo_setup-0.3.2/README.md

@@ -0,0 +1,68 @@
+# 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. It generates async DB connections, Pydantic settings, and a fully functional CRUD router in one command.
+
+---
+
+## ⚡ Installation
+
+Install globally or within your virtual environment:
+
+```bash
+pip install fastapi-mongo-setup
+```
+
+## 🛠️ Usage
+
+Navigate to the root of your empty (or existing) FastAPI project and run:
+
+```bash
+mongo-setup
+```
+
+### What does this command do?
+Instantly, it generates the following modular architecture:
+
+```text
+fastapi-project/
+├── .env                   # Auto-populated with MONGODB_URL and DATABASE_NAME
+├── requirements.txt       # Dependencies (fastapi, motor, pydantic-settings, etc)
+├── main.py                # FastAPI entry point with MongoDB Lifespan logic
+└── src/
+    ├── config.py          # Configuration loader using Pydantic Settings
+    ├── utils/             # Database core
+    │   ├── db.py          # Asynchronous Motor connection manager
+    │   └── helpers.py     # MongoDB ObjectId Serialization helpers
+    └── tasks/             # Complete pre-built API module
+        ├── router.py      # GET/POST/DELETE endpoints
+        ├── schemas.py     # Pydantic validation models
+        └── service.py     # Database CRUD logic
+```
+
+## 🚀 Running Your Generated Project
+
+Once the files are created, just install the dependencies and start the built-in demo server!
+
+```bash
+# 1. Install required packages
+pip install -r requirements.txt
+
+# 2. Run the server
+python main.py
+```
+
+Go to `http://localhost:8000/docs` to see your automatically generated Swagger UI with a fully functional `Tasks` API connected to your MongoDB!
+
+---
+
+## 🏗 Why this exists?
+
+Setting up `Motor` (the async MongoDB driver) with FastAPI usually requires copy-pasting code to handle connections, lifespans, and fixing `ObjectId` serialization errors. This minimalist tool does all of that for you, providing a clean abstraction layer and a modular structure designed for scaling.
+
+## 🤝 Contributing
+Found a bug or want to request a feature? Feel free to open an issue or submit a pull request!

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

@@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-mongo-setup"
-version = "0.3.0"
+version = "0.3.2"
 description = "A CLI tool to auto-generate MongoDB connection boilerplates for FastAPI projects."
 authors = [
-    {name = "Developer Name", email = "developer@example.com"},
+    {name = "Souvik", email = "wbjee.souvik@gmail.com"},
 ]
 readme = "README.md"
 requires-python = ">=3.8"
@@ -18,6 +18,10 @@ dependencies = [
     "pydantic-settings"
 ]
 
+[project.urls]
+Homepage = "https://github.com/Souvik6222/fastapi-mongo-setup"
+Issues = "https://github.com/Souvik6222/fastapi-mongo-setup/issues"
+
 [project.scripts]
 mongo-setup = "mongo_setup.cli:init"
 

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

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: fastapi-mongo-setup
+Version: 0.3.2
+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. It generates async DB connections, Pydantic settings, and a fully functional CRUD router in one command.
+
+---
+
+## ⚡ Installation
+
+Install globally or within your virtual environment:
+
+```bash
+pip install fastapi-mongo-setup
+```
+
+## 🛠️ Usage
+
+Navigate to the root of your empty (or existing) FastAPI project and run:
+
+```bash
+mongo-setup
+```
+
+### What does this command do?
+Instantly, it generates the following modular architecture:
+
+```text
+fastapi-project/
+├── .env                   # Auto-populated with MONGODB_URL and DATABASE_NAME
+├── requirements.txt       # Dependencies (fastapi, motor, pydantic-settings, etc)
+├── main.py                # FastAPI entry point with MongoDB Lifespan logic
+└── src/
+    ├── config.py          # Configuration loader using Pydantic Settings
+    ├── utils/             # Database core
+    │   ├── db.py          # Asynchronous Motor connection manager
+    │   └── helpers.py     # MongoDB ObjectId Serialization helpers
+    └── tasks/             # Complete pre-built API module
+        ├── router.py      # GET/POST/DELETE endpoints
+        ├── schemas.py     # Pydantic validation models
+        └── service.py     # Database CRUD logic
+```
+
+## 🚀 Running Your Generated Project
+
+Once the files are created, just install the dependencies and start the built-in demo server!
+
+```bash
+# 1. Install required packages
+pip install -r requirements.txt
+
+# 2. Run the server
+python main.py
+```
+
+Go to `http://localhost:8000/docs` to see your automatically generated Swagger UI with a fully functional `Tasks` API connected to your MongoDB!
+
+---
+
+## 🏗 Why this exists?
+
+Setting up `Motor` (the async MongoDB driver) with FastAPI usually requires copy-pasting code to handle connections, lifespans, and fixing `ObjectId` serialization errors. This minimalist tool does all of that for you, providing a clean abstraction layer and a modular structure designed for scaling.
+
+## 🤝 Contributing
+Found a bug or want to request a feature? Feel free to open an issue or submit a pull request!

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

@@ -8,5 +8,8 @@ src/fastapi_mongo_setup.egg-info/requires.txt
 src/fastapi_mongo_setup.egg-info/top_level.txt
 src/mongo_setup/__init__.py
 src/mongo_setup/cli.py
+src/tasks/router.py
+src/tasks/schemas.py
+src/tasks/service.py
 src/utils/db.py
 src/utils/helpers.py

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

@@ -1,2 +1,3 @@
 mongo_setup
+tasks
 utils

{fastapi_mongo_setup-0.3.0 → fastapi_mongo_setup-0.3.2}/src/mongo_setup/cli.py

@@ -205,14 +205,14 @@ if __name__ == "__main__":
             env_content = f.read()
 
     with open(env_file, "a", encoding="utf-8") as f:
-        if env_content and not env_content.endswith("\\n"):
-            f.write("\\n")
+        if env_content and not env_content.endswith("\n"):
+            f.write("\n")
         if "MONGODB_URL" not in env_content:
-            f.write("MONGODB_URL=mongodb://localhost:27017\\n")
+            f.write("MONGODB_URL=mongodb://localhost:27017\n")
         if "DATABASE_NAME" not in env_content:
-            f.write("DATABASE_NAME=fastapi_db\\n")
+            f.write("DATABASE_NAME=fastapi_db\n")
         if "PORT" not in env_content:
-            f.write("PORT=8000\\n")
+            f.write("PORT=8000\n")
             
     print("Updated .env file with MongoDB environment variables.")
 

fastapi_mongo_setup-0.3.2/src/tasks/router.py

@@ -0,0 +1,22 @@
+from fastapi import APIRouter, HTTPException
+from typing import List
+from src.tasks.schemas import TaskCreate, TaskResponse
+from src.tasks.service import TaskService
+
+router = APIRouter(prefix="/tasks", tags=["Tasks"])
+
+@router.post("/", response_model=TaskResponse)
+async def create_task(task: TaskCreate):
+    created_task = await TaskService.create_task(task.model_dump())
+    return created_task
+
+@router.get("/", response_model=List[TaskResponse])
+async def get_tasks():
+    return await TaskService.get_all_tasks()
+
+@router.delete("/{task_id}")
+async def delete_task(task_id: str):
+    success = await TaskService.delete_task(task_id)
+    if not success:
+        raise HTTPException(status_code=404, detail="Task not found")
+    return {"message": "Task deleted successfully"}

fastapi_mongo_setup-0.3.2/src/tasks/schemas.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+
+class TaskCreate(BaseModel):
+    title: str = Field(..., example="Buy groceries")
+    description: Optional[str] = Field(None, example="Milk, Eggs, Bread")
+    completed: bool = False
+
+class TaskResponse(TaskCreate):
+    id: str

fastapi_mongo_setup-0.3.2/src/tasks/service.py

@@ -0,0 +1,25 @@
+from src.utils.db import db
+from src.utils.helpers import serialize_doc, serialize_docs
+from bson import ObjectId
+
+class TaskService:
+    @staticmethod
+    def get_collection():
+        return db.db["tasks"]
+
+    @staticmethod
+    async def create_task(task_data: dict) -> dict:
+        result = await TaskService.get_collection().insert_one(task_data)
+        created_task = await TaskService.get_collection().find_one({"_id": result.inserted_id})
+        return serialize_doc(created_task)
+
+    @staticmethod
+    async def get_all_tasks() -> list:
+        cursor = TaskService.get_collection().find()
+        tasks = await cursor.to_list(length=100)
+        return serialize_docs(tasks)
+
+    @staticmethod
+    async def delete_task(task_id: str) -> bool:
+        result = await TaskService.get_collection().delete_one({"_id": ObjectId(task_id)})
+        return result.deleted_count > 0

fastapi_mongo_setup-0.3.0/PKG-INFO

@@ -1,35 +0,0 @@
-Metadata-Version: 2.4
-Name: fastapi-mongo-setup
-Version: 0.3.0
-Summary: A CLI tool to auto-generate MongoDB connection boilerplates for FastAPI projects.
-Author-email: Developer Name <developer@example.com>
-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
-
-A Python CLI package that automatically creates a MongoDB connection structure for FastAPI projects.
-
-## Installation
-
-```bash
-pip install fastapi-mongo-setup
-```
-
-## Usage
-
-Navigate to the root of your FastAPI project and run:
-
-```bash
-mongo-setup
-```
-
-This command will:
-- Check if the `src/utils` directory exists (creates it if it doesn't).
-- Generate a `src/utils/db.py` file containing an asynchronous `Database` class using `motor`. This includes `connect_to_mongodb` and `close_mongodb_connection` methods.
-- Generate a `src/utils/helpers.py` file with a `serialize_doc` function to convert MongoDB `ObjectId` types to plain strings.
-- Automatically append `MONGODB_URL` and `DATABASE_NAME` variables to your `.env` file.

fastapi_mongo_setup-0.3.0/README.md

@@ -1,23 +0,0 @@
-# fastapi-mongo-setup
-
-A Python CLI package that automatically creates a MongoDB connection structure for FastAPI projects.
-
-## Installation
-
-```bash
-pip install fastapi-mongo-setup
-```
-
-## Usage
-
-Navigate to the root of your FastAPI project and run:
-
-```bash
-mongo-setup
-```
-
-This command will:
-- Check if the `src/utils` directory exists (creates it if it doesn't).
-- Generate a `src/utils/db.py` file containing an asynchronous `Database` class using `motor`. This includes `connect_to_mongodb` and `close_mongodb_connection` methods.
-- Generate a `src/utils/helpers.py` file with a `serialize_doc` function to convert MongoDB `ObjectId` types to plain strings.
-- Automatically append `MONGODB_URL` and `DATABASE_NAME` variables to your `.env` file.

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

@@ -1,35 +0,0 @@
-Metadata-Version: 2.4
-Name: fastapi-mongo-setup
-Version: 0.3.0
-Summary: A CLI tool to auto-generate MongoDB connection boilerplates for FastAPI projects.
-Author-email: Developer Name <developer@example.com>
-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
-
-A Python CLI package that automatically creates a MongoDB connection structure for FastAPI projects.
-
-## Installation
-
-```bash
-pip install fastapi-mongo-setup
-```
-
-## Usage
-
-Navigate to the root of your FastAPI project and run:
-
-```bash
-mongo-setup
-```
-
-This command will:
-- Check if the `src/utils` directory exists (creates it if it doesn't).
-- Generate a `src/utils/db.py` file containing an asynchronous `Database` class using `motor`. This includes `connect_to_mongodb` and `close_mongodb_connection` methods.
-- Generate a `src/utils/helpers.py` file with a `serialize_doc` function to convert MongoDB `ObjectId` types to plain strings.
-- Automatically append `MONGODB_URL` and `DATABASE_NAME` variables to your `.env` file.