shafikul-cli 2.0.1__tar.gz → 2.1.2__tar.gz

{shafikul_cli-2.0.1/shafikul_cli.egg-info → shafikul_cli-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shafikul_cli
-Version: 2.0.1
+Version: 2.1.2
 Summary: CLI tool for FastAPI scaffolding with router, models, database, and templates.
 Author-email: Md Shafikul Islam <buildwithshafikul@gmail.com>
 Project-URL: Homepage, https://github.com/build-with-shafikul/shafikul_cli

{shafikul_cli-2.0.1 → shafikul_cli-2.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "shafikul_cli"
-version = "2.0.1"
+version = "2.1.2"
 description = "CLI tool for FastAPI scaffolding with router, models, database, and templates."
 readme = "README.md"
 requires-python = ">=3.9"

shafikul_cli-2.1.2/shafikul_cli/main.py

@@ -0,0 +1,178 @@
+import os
+import typer
+import sys 
+from typing import Optional
+from rich.console import Console
+from rich.panel import Panel
+from rich.text import Text
+from importlib.metadata import version as project_version
+from shafikul_cli.utility.install_dependicy import install_dependencies, alembic_init, user_table_autogenerate
+from shafikul_cli.utility.ensure_db import ensure_db_in_main
+from shafikul_cli.utility.ensure_main import ensure_main_py
+from shafikul_cli.utility.env_generate import ensure_env_file
+from shafikul_cli.utility.create_html_file import create_html_file
+from shafikul_cli.utility.create_file_structure import create_file_structure
+from shafikul_cli.utility.create_file_content import file_inside_content
+from shafikul_cli.utility.helper_function import edit_migration_env
+
+
+app = typer.Typer(help="Shafikul CLI for FastAPI")
+create_app_cli = typer.Typer(help="Create resources")
+app.add_typer(create_app_cli, name="create")
+console = Console()
+
+# =========================================================
+# 🎨 COLORED BANNER
+# =========================================================
+def show_banner():
+    banner = Text("Shafikul CLI", style="bold cyan")
+    subtitle = Text(f"Version v{project_version('shafikul-cli')} • FastAPI Toolkit", style="green")
+
+    panel = Panel.fit(
+        Text.assemble(banner, "\n", subtitle),
+        border_style="bright_blue",
+    )
+
+    console.print(panel)
+
+
+# =========================================================
+# 📘 ABOUT & (--version) COMMAND
+# =========================================================
+@app.callback(invoke_without_command=True)
+def show_option_command(
+    ctx: typer.Context,
+    version: bool = typer.Option(
+        False, "--version", "-V", "-v",
+        help="Show CLI version",
+        is_eager=True,
+    ),
+    about: bool = typer.Option(
+        False, "--about", "-A", "-a",
+        help="Show information about Shafikul CLI",
+        is_eager=True,
+    ),
+):
+    if version:
+        console.print(f"[bold green]Shafikul CLI v{project_version("shafikul-cli")}[/]")
+        raise typer.Exit()
+    
+    if about:
+        show_banner()
+        console.print("\n[bold]Author:[/] MD: Shafikul Islam")
+        console.print("[bold]Purpose:[/] FastAPI project scaffolding")
+        console.print("[bold]GitHub:[/] https://github.com/build-with-shafikul/shafikul_cli")
+        console.print("[bold]License:[/] MIT License\n")
+        raise typer.Exit()
+    
+    # 👉 যদি কোনো command না দেয়
+    if ctx.invoked_subcommand is None:
+        typer.echo(ctx.get_help())
+        raise typer.Exit()
+    
+
+# =========================================================
+# 🛠 CREATE APP
+# =========================================================
+@create_app_cli.command("app")
+def create_app():
+    # target: Optional[str] = typer.Argument(None, help="structure")
+    
+    show_banner()
+   
+    folders = [
+        "app",
+        "config",
+        "asset/css",
+        "asset/images",
+        "asset/js",
+        "static/images",
+        "router/web",
+        "router/api",
+        "templates/layouts",
+        "templates/pages/auth",
+        "templates/pages/authenticated",
+        "templates/pages/error",
+        "templates/pages/public",
+        "utility"
+    ]
+
+    files = [
+        ".env",
+        ".env.example",
+        ".gitignore",
+        "requirements.txt",
+        "README.md",
+        "main.py",
+        "config/app.py",
+        "app/database.py",
+        "app/models.py",
+        "asset/css/style.css",
+        "asset/images/icon.png",
+        "static/images/logo.png",
+        "asset/js/script.js",
+        "router/api/users.py",
+        "router/web/auth.py",
+        "router/web/error.py",
+        "router/web/public.py",
+        "utility/helper_function.py",
+        "templates/layouts/main.html",
+        "templates/layouts/auth.html",
+        "templates/pages/public/index.html",
+        "templates/pages/error/notfound.html",
+        "templates/pages/authenticated/dashboard.html",
+        "templates/pages/auth/login.html",
+        "templates/pages/auth/registater.html",
+    ]
+
+    for folder in folders:
+        console.print("[bold green]Creating Folder: [/] " + folder )
+        os.makedirs(folder, exist_ok=True)
+
+    for file in files:
+        file_inside_content(file)
+
+    console.print("\n[green]Project structure created successfully![/]")
+
+    # ==========================================
+    # Install Dependices
+    # ==========================================
+    install_dependencies([
+        "python-dotenv",
+        "fastapi",
+        "uvicorn[standard]",
+        "jinja2",
+        "sqlalchemy",
+        "itsdangerous",
+        "passlib[bcrypt]",
+        "argon2-cffi",
+        "python-multipart",
+    ])
+
+    # ==========================================
+    # sqlalchemy alembic initionalize
+    # ==========================================
+    alembic_init()
+
+    # ==========================================
+    # sqlalchemy Migration Env add .env file database url
+    # ==========================================
+    edit_migration_env()
+
+    # ==========================================
+    # User Table Create
+    # ==========================================
+    user_table_autogenerate()
+
+    console.print(
+
+Panel(
+    "[bold underline cyan]uvicorn main:app --reload[/]",
+    title="🌐 Running Server",
+    border_style="green"
+)
+)
+
+
+if __name__ == "__main__":
+    app()

shafikul_cli-2.1.2/shafikul_cli/utility/create_file_content.py

@@ -0,0 +1,77 @@
+from rich.console import Console
+from . import helper_function as Hfn
+     
+console = Console()
+
+def file_inside_content(file_name: str):
+    console.print("[bold magenta]Creating File: [/] " + file_name )
+    if file_name == '.env':
+        Hfn.env(file_name)
+
+    if file_name == '.env.example':
+        Hfn.env_example(file_name)
+
+    if file_name == '.gitignore':
+        Hfn.gitignore(file_name)
+    
+    if file_name == 'requirements.txt':
+        Hfn.requirements(file_name)
+    
+    if file_name == 'README.md':
+        Hfn.readme(file_name)
+
+    if file_name == 'main.py':
+        Hfn.mainfile(file_name)
+    
+    if file_name == 'config/app.py':
+        Hfn.config_app(file_name)
+    
+    if file_name == 'app/database.py':
+        Hfn.database(file_name)
+    
+    if file_name == 'app/models.py':
+        Hfn.models(file_name)
+    
+    if file_name == 'router/api/users.py':
+        Hfn.api_user_route(file_name)
+    
+    if file_name == 'router/web/auth.py':
+        Hfn.web_auth_route(file_name)
+    
+    if file_name == 'router/web/error.py':
+        Hfn.web_error_route(file_name)
+    
+    if file_name == 'router/web/public.py':
+        Hfn.web_public_route(file_name)
+
+    if file_name == 'utility/helper_function.py':
+        Hfn.helper_function(file_name)
+
+    if file_name == 'templates/layouts/main.html':
+        Hfn.main_layout(file_name)
+    
+    if file_name == 'templates/layouts/auth.html':
+        Hfn.auth_layout(file_name)
+    
+    if file_name == 'templates/pages/public/index.html':
+        Hfn.index(file_name)
+    
+    if file_name == 'templates/pages/error/notfound.html':
+        Hfn.notfound(file_name)
+    
+    if file_name == 'templates/pages/authenticated/dashboard.html':
+        Hfn.dashboard(file_name)
+    
+    if file_name == 'templates/pages/auth/login.html':
+        Hfn.login(file_name)
+    
+    if file_name == 'templates/pages/auth/registater.html':
+        Hfn.registater(file_name)
+    
+
+    if file_name == 'static/images/logo.png':
+        Hfn.static_logo(file_name)
+    
+    # if file_name == 'main':
+    #     pass
+