fastapi-mongo-setup 0.1.0__tar.gz

fastapi_mongo_setup-0.1.0/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: fastapi-mongo-setup
+Version: 0.1.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
+
+# 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.1.0/README.md

@@ -0,0 +1,23 @@
+# 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.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fastapi-mongo-setup"
+version = "0.1.0"
+description = "A CLI tool to auto-generate MongoDB connection boilerplates for FastAPI projects."
+authors = [
+    {name = "Developer Name", email = "developer@example.com"},
+]
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "motor",
+    "python-dotenv",
+    "fastapi"
+]
+
+[project.scripts]
+mongo-setup = "mongo_setup.cli:init"
+
+[tool.setuptools.packages.find]
+where = ["src"]

fastapi_mongo_setup-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

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

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: fastapi-mongo-setup
+Version: 0.1.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
+
+# 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.1.0/src/fastapi_mongo_setup.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+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
+src/fastapi_mongo_setup.egg-info/entry_points.txt
+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

fastapi_mongo_setup-0.1.0/src/fastapi_mongo_setup.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fastapi_mongo_setup-0.1.0/src/fastapi_mongo_setup.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mongo-setup = mongo_setup.cli:init

fastapi_mongo_setup-0.1.0/src/fastapi_mongo_setup.egg-info/requires.txt

@@ -0,0 +1,3 @@
+motor
+python-dotenv
+fastapi

fastapi_mongo_setup-0.1.0/src/fastapi_mongo_setup.egg-info/top_level.txt

@@ -0,0 +1 @@
+mongo_setup

fastapi_mongo_setup-0.1.0/src/mongo_setup/__init__.py

@@ -0,0 +1 @@
+"""fastapi-mongo-setup package"""

fastapi_mongo_setup-0.1.0/src/mongo_setup/cli.py

@@ -0,0 +1,84 @@
+import os
+import pathlib
+
+def init():
+    print("Initializing MongoDB setup for FastAPI...")
+    
+    # Check if src/utils exists (create if not)
+    utils_dir = pathlib.Path("src/utils")
+    utils_dir.mkdir(parents=True, exist_ok=True)
+    
+    # 1. Create src/utils/db.py
+    db_file = utils_dir / "db.py"
+    if not db_file.exists():
+        with open(db_file, "w", encoding="utf-8") as f:
+            f.write("""import os
+from motor.motor_asyncio import AsyncIOMotorClient
+from dotenv import load_dotenv
+
+load_dotenv()
+
+class Database:
+    client: AsyncIOMotorClient = None
+    db = None
+
+db = Database()
+
+async def connect_to_mongodb():
+    mongodb_url = os.getenv("MONGODB_URL", "mongodb://localhost:27017")
+    database_name = os.getenv("DATABASE_NAME", "fastapi_db")
+    
+    db.client = AsyncIOMotorClient(mongodb_url)
+    db.db = db.client[database_name]
+    
+    # Ping the database to ensure a successful connection
+    await db.client.admin.command('ping')
+    print("Connected to MongoDB!")
+
+async def close_mongodb_connection():
+    if db.client:
+        db.client.close()
+        print("Closed MongoDB connection.")
+""")
+        print(f"Created {db_file}")
+    else:
+        print(f"{db_file} already exists, skipping.")
+
+    # 2. Create src/utils/helpers.py
+    helpers_file = utils_dir / "helpers.py"
+    if not helpers_file.exists():
+        with open(helpers_file, "w", encoding="utf-8") as f:
+            f.write("""def serialize_doc(doc):
+    \"\"\"Convert MongoDB ObjectId to string\"\"\"
+    if doc and "_id" in doc:
+        doc["id"] = str(doc["_id"])
+        del doc["_id"]
+    return doc
+""")
+        print(f"Created {helpers_file}")
+    else:
+        print(f"{helpers_file} already exists, skipping.")
+
+    # 3. Append to .env
+    env_file = pathlib.Path(".env")
+    env_content = ""
+    
+    if env_file.exists():
+        with open(env_file, "r", encoding="utf-8") as f:
+            env_content = f.read()
+
+    with open(env_file, "a", encoding="utf-8") as f:
+        # Add a newline if the file does not end with one
+        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")
+        if "DATABASE_NAME" not in env_content:
+            f.write("DATABASE_NAME=fastapi_db\\n")
+            
+    print("Appended MONGODB_URL and DATABASE_NAME placeholders to .env")
+    print("MongoDB setup complete!")
+
+if __name__ == "__main__":
+    init()