Merge pull request #5 from brianobot/dev

Improve Code Readility and Fix issues with Incorrect Project Detail Initialization

Author: brianobot

.gitignore

@@ -1,3 +1,6 @@
-.env
+*.env
 venv/
+dist/
 *__pycache__*
+data.json
+publish_2_pypi.sh

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-# FastAPI Project Gen8
+# FastAPI Gen8
 
 ______________________________________________________________
 
@@ -24,18 +24,22 @@ ______________________________________________________________
         ╚═════╝ ╚══════╝╚═╝  ╚═══╝╚═══╝ ╚════╝    
 ______________________________________________________________
 
-Generate FastAPI Projects in Seconds
+Generate FastAPI Projects in Seconds 🚀
 
 ## Overview
 
-FastAPI Project Gen8 is a lightweight command-line tool designed to generate clean, structured, production-ready FastAPI project scaffolds at warp speed.
+FastAPI Gen8 is a lightweight command-line tool designed to generate clean, structured, production-ready FastAPI project scaffolds at warp speed.
 Whether you're spinning up a new microservice or testing a prototype idea, Gen8 gives you a fresh, organized foundation with sensible defaults — so you can focus on building, not boring setup rituals.
 
+
 ### Prerequisites
 
 Before igniting the generator, make sure you've completed the following:
 
 - Create a remote Git repository for your new project.
+- Optionally Setup a Database (E.g, Postgres, MySQL) for your Fastapi
+- Setup a Redis Server running on your machine
+
 
 Gen8 will automatically initialize Git and link your project to the remote origin you provide.
 (Think of it as handing the newborn project its first passport.)
@@ -50,7 +54,7 @@ Gen8 will automatically initialize Git and link your project to the remote origi
 
 Installation
 ```bash
-pip install fastapi-project-gen8
+pip install fastapi-gen8
 ```
 
 (or whatever installation method your tool uses — adjust as needed.)
@@ -59,6 +63,8 @@ Usage
 ```bash
 fastapi-gen8
 ```
+![Introduction Screenshot](images/intro_demo.png)
+
 
 You’ll be prompted for project details such as name, slug, description, and Git remote URL.
 Then—whoosh!—a fully structured FastAPI project appears in your universe.
@@ -69,15 +75,29 @@ fastapi-gen8 --name "my-awesome-api" --remote "git@github.com:me/my-awesome-api.
 #### Project Structure
 A typical generated project looks like:
 
-my-awesome-api/
+```
+<project_slug_name>/
 ├── app/
 │   ├── main.py
 │   ├── routers/
-│   └── core/
+│   ├── models/
+│   ├── services/
+│   ├── __init__.py
+│   ├── main.py
+│   ├── api_router.py
+│   ├── dependencies.py
+│   ├── logger.py
+│   ├── middlewares.py
+│   ├── mailer.py
+│   ├── redis_manager.py
+│   └── utils
 ├── requirements.txt
+├── alembic/
+├── alembic.ini
 ├── .gitignore
 ├── README.md
 └── ...
+```
 
 ## Why FastAPI Gen8?
 
@@ -86,4 +106,4 @@ my-awesome-api/
 - Because momentum matters — and FastAPI Gen8 gives you that first push.
 
 ## License
-- MIT License
+- [MIT License](LICENSE)

images/intro_demo.png

@@ -0,0 +1,4 @@
+python3 -m build
+
+pip install -e .
+

local_build_and_install.sh

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "fastapi-gen8"
+version = "0.0.6"
+authors = [
+  { name="Brian Obot", email="brianobot9@gmail.com" },
+]
+description = "FastAPI Project Gen8 is a lightweight command-line tool designed to generate clean, structured, production-ready FastAPI project scaffolds at warp speed"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/brianobot/fastapi-project-gen8"
+Issues = "https://github.com/brianobot/fastapi-project-gen8/issues"
+
+[project.scripts]
+fastapi-gen8 = "fastapi_gen8.main:main"

pyproject.toml

@@ -0,0 +1 @@
+faker

requirements.txt

@@ -0,0 +1,79 @@
+import subprocess
+
+
+def display_intro_text() -> None:
+    """
+    Displays the Introduction Text of the Library as a Nice and Friendly UI
+    Alongside a short instructions on how to use the library for new users.
+    """
+    intro_message = """
+    ______________________________________________________________
+    
+    ███████╗ █████╗ ███████╗████████╗ █████╗ ██████╗ ██╗ 
+    ██╔════╝██╔══██╗██╔════╝╚══██╔══╝██╔══██╗██╔══██╗██║
+    █████╗  ███████║███████╗   ██║   ███████║██████╔╝██║
+    ██╔══╝  ██╔══██║╚════██║   ██║   ██╔══██║██      ██║
+    ██║     ██║  ██║███████║   ██║   ██║  ██║██║    ║██║
+    ╚═╝     ╚═╝  ╚═╝╚══════╝   ╚═╝   ╚═╝  ╚═╝╚═╝    ╚╝╚╝
+    
+    ██████╗ ██████╗  ██████╗ ███████╗███████╗ ██████  ████████╗
+    ██╔══██╗██╔══██╗██╔═══██╗ ════██╗██╔════╝██╔════╝ ╚══██╔══╝
+    ██████╔╝██████╔╝██║   ██║     ██║█████╗  ██║         ██║   
+    ██╔═══╝ ██╔══██╗██║   ██║███  ██║██╔══╝  ██║         ██║   
+    ██║     ██║  ██║╚██████╔╝██████╔╝███████╗╚██████╗    ██║   
+    ╚═╝     ╚═╝  ╚═╝ ╚═════╝ ╚═════╝ ╚══════╝ ╚═════╝    ╚═╝                     
+                                                                 
+     ██████╗ ███████╗███╗   ██╗ █████╗     
+    ██╔════╝ ██╔════╝████╗  ██║██╔══██╗    
+    ██║  ███╗█████╗  ██╔██╗ ██║ █████╔╝   
+    ██║   ██║██╔══╝  ██║╚██╗██║██╔══██╗  
+    ╚██████╔╝███████╗██║ ╚████║ █████╔╝  
+        ╚═════╝ ╚══════╝╚═╝  ╚╝ ╚════╝    
+    ______________________________________________________________
+    """
+    print(intro_message)
+    description = """
+    Generate a fully structured FastAPI projects instantly.  
+    Boilerplate code, ready-to-run endpoints, and project scaffolding  
+    all in one simple command. Kickstart your backend in seconds!
+    
+    Provide Project Details to each prompt and press 'Enter' to complete project setup
+    
+    NOTES: Values placed within square brackets ([My Awesome FastAPI Project]) are defaults values for the project details
+    If you do not provide a value for any particular, those values are used instead.
+    
+    Have a Blast 🚀 - Brian
+    _____________________________________________________________________________________________________
+    """
+    # FUN 🚀
+    
+    # How Fast Can you Complete your FastAPI project setup?
+    # Blaze through the steps to make the global leaderboard for projects generated with FastAPI Project Gen8.
+    # In Order to qualify for this leaderboard, you have to make sure to input every project detail and not use defaults
+    # even though the defaults match your project attribute.
+    # Current Best Record: {get_current_best_record()[0]} seconds - Title: [{get_current_best_record()[1]}] 
+    print(description)
+
+
+def slugify(text: str) -> str:
+    return text.replace(" ", "_").replace("-", "_").lower()
+
+def success_print(value: str):
+    print("\033[92m{}\033[00m".format(value))
+
+def warning_print(value: str):
+    print("\033[33m{}\033[00m".format(value))
+
+def error_print(value: str):
+    print("\033[31m{}\033[00m".format(value))
+
+
+def clone_repository(repository_url: str, folder_name: str):
+    try:
+        clone_template_repo = subprocess.Popen(["git", "clone", repository_url, folder_name])
+        clone_template_repo.wait()
+    except Exception as err:
+        error_print(f"Failed to Download Template: Reason: {err}")
+        exit(1)
+    
+