backend-dash 0.1.0__tar.gz

backend_dash-0.1.0/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+
+# Build artifacts
+dist/
+build/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Env files / secrets
+.env
+
+# Editor
+.vscode/
+.idea/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# SQLite databases generated by running the app
+*.db

backend_dash-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pratham
+
+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.

backend_dash-0.1.0/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: backend-dash
+Version: 0.1.0
+Summary: Scaffold a FastAPI + SQLAlchemy backend with SQLite/Postgres/MySQL and optional JWT + Google OAuth auth
+Project-URL: Homepage, https://github.com/prathamdmehta/backend-dash
+Project-URL: Repository, https://github.com/prathamdmehta/backend-dash
+Author: Pratham
+License-Expression: MIT
+License-File: LICENSE
+Keywords: backend,boilerplate,cli,fastapi,scaffold,sqlalchemy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.10
+Requires-Dist: jinja2>=3.1
+Requires-Dist: typer>=0.12
+Description-Content-Type: text/markdown
+
+# backend-dash
+
+A CLI that generates ready-to-code FastAPI backend projects with SQLAlchemy, SQLite, PostgreSQL, MySQL, Alembic migrations, CRUD examples, tests, and optional JWT + Google OAuth authentication.
+
+## Features
+
+- Scaffold a complete FastAPI backend in seconds.
+- Supports `--db=sqlite|postgres|mysql` with SQLite as the default.
+- Generates a working SQLAlchemy setup and DB session wiring.
+- Adds an example CRUD resource so you can start from real code, not boilerplate.
+- Includes tests for the generated project.
+- Adds Alembic migrations for PostgreSQL and MySQL.
+- Keeps SQLite simple with `create_all` for zero-config local development.
+- Optional `--auth` mode adds JWT + Google OAuth auth support.
+- Clear validation for unsupported database values.
+- Clean `.env.example` setup for local development and migrations.
+
+## Installation
+
+### One-off usage
+
+```bash
+uvx backend-dash init "My API"
+```
+
+### Install locally
+
+```bash
+pip install backend-dash
+backend-dash init "My API"
+```
+
+### Editable install for development
+
+```bash
+git clone https://github.com/prathamdmehta/backend-dash.git
+cd backend-dash
+pip install -e . --break-system-packages
+```
+
+## Usage
+
+Create a new project:
+
+```bash
+backend-dash init "Demo Project"
+```
+
+Create a project with auth:
+
+```bash
+backend-dash init "Demo Project Auth" --auth
+```
+
+Choose a database:
+
+```bash
+backend-dash init "My API" --db=sqlite
+backend-dash init "My API" --db=postgres
+backend-dash init "My API" --db=mysql
+```
+
+Combine database and auth:
+
+```bash
+backend-dash init "My API" --db=postgres --auth
+```
+
+## What gets generated
+
+### Base project
+
+- FastAPI app structure.
+- SQLAlchemy session and base model wiring.
+- Example item resource with CRUD routes.
+- Pydantic schemas and models.
+- Pytest test setup.
+
+### With `--auth`
+
+- Repository layer with a generic `BaseRepository` and `UserRepository`.
+- Auth service for registration, login, JWT issuance, and Google token exchange.
+- Validation with proper schema constraints.
+- Centralized error handling with a consistent error response shape.
+- Auth routes for register, login, me, Google login, and Google callback.
+
+## Database support
+
+### SQLite
+
+SQLite is the default and uses `create_all` for a simple local setup.
+
+### PostgreSQL
+
+For PostgreSQL, the scaffold uses Alembic migrations and real schema management.
+
+### MySQL
+
+For MySQL, the scaffold also uses Alembic migrations and the correct MySQL driver setup.
+
+## Migrations
+
+For PostgreSQL and MySQL, the project generates Alembic configuration and an `env.py` wired to `DATABASE_URL` and your app metadata.
+
+Typical workflow:
+
+```bash
+alembic revision --autogenerate -m "create initial tables"
+alembic upgrade head
+```
+
+The generated `.env.example` includes the right migration flow so you can move from scaffold to production-style schema management quickly.
+
+## Project structure
+
+```bash
+my_api/
+├── app/
+├── tests/
+├── alembic/
+├── alembic.ini
+└── .env.example
+```
+
+If `--auth` is enabled, additional auth-related modules are included inside the app structure.
+
+## Example
+
+Generate a new API project:
+
+```bash
+backend-dash init "Orders API" --db=postgres --auth
+```
+
+This creates a FastAPI backend with database wiring, migrations, tests, and authentication already in place, so you can start on business logic immediately.
+
+## Development
+
+```bash
+git clone https://github.com/prathamdmehta/backend-dash.git
+cd backend-dash
+pip install -e . --break-system-packages
+```
+
+Then run the CLI locally:
+
+```bash
+backend-dash init "Demo Project"
+```
+
+## License
+
+MIT

backend_dash-0.1.0/README.md

@@ -0,0 +1,153 @@
+# backend-dash
+
+A CLI that generates ready-to-code FastAPI backend projects with SQLAlchemy, SQLite, PostgreSQL, MySQL, Alembic migrations, CRUD examples, tests, and optional JWT + Google OAuth authentication.
+
+## Features
+
+- Scaffold a complete FastAPI backend in seconds.
+- Supports `--db=sqlite|postgres|mysql` with SQLite as the default.
+- Generates a working SQLAlchemy setup and DB session wiring.
+- Adds an example CRUD resource so you can start from real code, not boilerplate.
+- Includes tests for the generated project.
+- Adds Alembic migrations for PostgreSQL and MySQL.
+- Keeps SQLite simple with `create_all` for zero-config local development.
+- Optional `--auth` mode adds JWT + Google OAuth auth support.
+- Clear validation for unsupported database values.
+- Clean `.env.example` setup for local development and migrations.
+
+## Installation
+
+### One-off usage
+
+```bash
+uvx backend-dash init "My API"
+```
+
+### Install locally
+
+```bash
+pip install backend-dash
+backend-dash init "My API"
+```
+
+### Editable install for development
+
+```bash
+git clone https://github.com/prathamdmehta/backend-dash.git
+cd backend-dash
+pip install -e . --break-system-packages
+```
+
+## Usage
+
+Create a new project:
+
+```bash
+backend-dash init "Demo Project"
+```
+
+Create a project with auth:
+
+```bash
+backend-dash init "Demo Project Auth" --auth
+```
+
+Choose a database:
+
+```bash
+backend-dash init "My API" --db=sqlite
+backend-dash init "My API" --db=postgres
+backend-dash init "My API" --db=mysql
+```
+
+Combine database and auth:
+
+```bash
+backend-dash init "My API" --db=postgres --auth
+```
+
+## What gets generated
+
+### Base project
+
+- FastAPI app structure.
+- SQLAlchemy session and base model wiring.
+- Example item resource with CRUD routes.
+- Pydantic schemas and models.
+- Pytest test setup.
+
+### With `--auth`
+
+- Repository layer with a generic `BaseRepository` and `UserRepository`.
+- Auth service for registration, login, JWT issuance, and Google token exchange.
+- Validation with proper schema constraints.
+- Centralized error handling with a consistent error response shape.
+- Auth routes for register, login, me, Google login, and Google callback.
+
+## Database support
+
+### SQLite
+
+SQLite is the default and uses `create_all` for a simple local setup.
+
+### PostgreSQL
+
+For PostgreSQL, the scaffold uses Alembic migrations and real schema management.
+
+### MySQL
+
+For MySQL, the scaffold also uses Alembic migrations and the correct MySQL driver setup.
+
+## Migrations
+
+For PostgreSQL and MySQL, the project generates Alembic configuration and an `env.py` wired to `DATABASE_URL` and your app metadata.
+
+Typical workflow:
+
+```bash
+alembic revision --autogenerate -m "create initial tables"
+alembic upgrade head
+```
+
+The generated `.env.example` includes the right migration flow so you can move from scaffold to production-style schema management quickly.
+
+## Project structure
+
+```bash
+my_api/
+├── app/
+├── tests/
+├── alembic/
+├── alembic.ini
+└── .env.example
+```
+
+If `--auth` is enabled, additional auth-related modules are included inside the app structure.
+
+## Example
+
+Generate a new API project:
+
+```bash
+backend-dash init "Orders API" --db=postgres --auth
+```
+
+This creates a FastAPI backend with database wiring, migrations, tests, and authentication already in place, so you can start on business logic immediately.
+
+## Development
+
+```bash
+git clone https://github.com/prathamdmehta/backend-dash.git
+cd backend-dash
+pip install -e . --break-system-packages
+```
+
+Then run the CLI locally:
+
+```bash
+backend-dash init "Demo Project"
+```
+
+## License
+
+MIT

backend_dash-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "backend-dash"
+version = "0.1.0"
+description = "Scaffold a FastAPI + SQLAlchemy backend with SQLite/Postgres/MySQL and optional JWT + Google OAuth auth"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "Pratham" },
+]
+keywords = ["fastapi", "sqlalchemy", "scaffold", "boilerplate", "cli", "backend"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Code Generators",
+    "Topic :: Software Development :: Build Tools",
+    "Framework :: FastAPI",
+]
+dependencies = [
+    "typer>=0.12",
+    "jinja2>=3.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/prathamdmehta/backend-dash"
+Repository = "https://github.com/prathamdmehta/backend-dash"
+
+[project.scripts]
+backend-dash = "fastapi_scaffolder.cli:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/fastapi_scaffolder"]

backend_dash-0.1.0/src/fastapi_scaffolder/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

backend_dash-0.1.0/src/fastapi_scaffolder/cli.py

@@ -0,0 +1,117 @@
+import re
+import shutil
+from pathlib import Path
+
+import typer
+from jinja2 import Environment, FileSystemLoader
+
+app = typer.Typer(
+    help="Scaffold a FastAPI + SQLAlchemy backend so you can skip the boilerplate."
+)
+
+TEMPLATES_ROOT = Path(__file__).parent / "templates"
+VALID_DBS = ("sqlite", "postgres", "mysql")
+
+
+def slugify(name: str) -> str:
+    """Turn 'My Cool API' into 'my_cool_api' for use as a folder name."""
+    slug = re.sub(r"[^a-zA-Z0-9]+", "_", name.strip()).strip("_").lower()
+    return slug or "backend_project"
+
+
+def render_template(template_dir: Path, target_dir: Path, context: dict) -> None:
+    env = Environment(loader=FileSystemLoader(str(template_dir)), keep_trailing_newline=True)
+
+    for src_path in sorted(template_dir.rglob("*")):
+        if src_path.is_dir():
+            continue
+
+        rel_path = src_path.relative_to(template_dir)
+        rel_str = rel_path.as_posix()
+        is_template = rel_str.endswith(".j2")
+        out_rel = Path(rel_str[:-3]) if is_template else rel_path
+        out_path = target_dir / out_rel
+        out_path.parent.mkdir(parents=True, exist_ok=True)
+
+        if is_template:
+            rendered = env.get_template(rel_str).render(**context)
+            out_path.write_text(rendered, encoding="utf-8")
+        else:
+            shutil.copy2(src_path, out_path)
+
+
+@app.command()
+def init(
+    project_name: str = typer.Argument(..., help="Human-readable project name, e.g. 'My API'"),
+    directory: str = typer.Option(
+        None,
+        "--dir",
+        help="Folder to create the project in. Defaults to a slugified version of the project name.",
+    ),
+    auth: bool = typer.Option(
+        False,
+        "--auth",
+        help="Include JWT + Google OAuth authentication (repository pattern, service layer, "
+        "centralized error handling, login/register/me routes).",
+    ),
+    db: str = typer.Option(
+        "sqlite",
+        "--db",
+        help="Database backend: sqlite (default, zero setup), postgres, or mysql "
+        "(both include Alembic migrations instead of auto-created tables).",
+    ),
+):
+    """
+    Generate a new FastAPI + SQLAlchemy + SQLite backend project.
+    """
+    db = db.lower()
+    if db not in VALID_DBS:
+        typer.secho(f"--db must be one of {VALID_DBS}, got '{db}'.", fg=typer.colors.RED)
+        raise typer.Exit(code=1)
+
+    project_slug = slugify(directory or project_name)
+    target_dir = Path.cwd() / project_slug
+
+    if target_dir.exists() and any(target_dir.iterdir()):
+        typer.secho(f"'{project_slug}' already exists and is not empty. Aborting.", fg=typer.colors.RED)
+        raise typer.Exit(code=1)
+
+    context = {"project_name": project_name, "project_slug": project_slug, "auth": auth, "db": db}
+
+    render_template(TEMPLATES_ROOT / "fastapi_sqlite", target_dir, context)
+    if auth:
+        render_template(TEMPLATES_ROOT / "fastapi_sqlite_auth", target_dir, context)
+    if db in ("postgres", "mysql"):
+        render_template(TEMPLATES_ROOT / "db_migrations", target_dir, context)
+
+    typer.secho(f"\n✅ Created '{project_name}' in ./{project_slug}\n", fg=typer.colors.GREEN, bold=True)
+    typer.echo("Next steps:")
+    typer.echo(f"  cd {project_slug}")
+    typer.echo("  pip install -r requirements.txt   # or: uv pip install -r requirements.txt")
+    typer.echo("  cp .env.example .env")
+    if db in ("postgres", "mysql"):
+        typer.echo(f"  # edit .env with your real {db} credentials, then:")
+        typer.echo('  alembic revision --autogenerate -m "initial tables"')
+        typer.echo("  alembic upgrade head")
+    if auth:
+        typer.echo("  # (optional) set GOOGLE_CLIENT_ID / GOOGLE_CLIENT_SECRET in .env for Google login")
+    typer.echo("  uvicorn app.main:app --reload")
+    if auth:
+        typer.echo("\nAuth endpoints: POST /api/v1/auth/register, POST /api/v1/auth/login, "
+                    "GET /api/v1/auth/me, GET /api/v1/auth/google/login")
+
+
+@app.command()
+def version():
+    """Print the fastapi-scaffolder version."""
+    from fastapi_scaffolder import __version__
+
+    typer.echo(__version__)
+
+
+def main():
+    app()
+
+
+if __name__ == "__main__":
+    main()

backend_dash-0.1.0/src/fastapi_scaffolder/templates/db_migrations/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

backend_dash-0.1.0/src/fastapi_scaffolder/templates/db_migrations/alembic/env.py

@@ -0,0 +1,52 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+# Pull the connection URL and model metadata from the app itself,
+# so alembic.ini never needs a hardcoded/duplicated DATABASE_URL.
+from app.core.config import settings
+from app.db.base import Base  # noqa: F401  (imports every model)
+
+config = context.config
+config.set_main_option("sqlalchemy.url", settings.DATABASE_URL)
+
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+target_metadata = Base.metadata
+
+
+def run_migrations_offline() -> None:
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(connection=connection, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

backend_dash-0.1.0/src/fastapi_scaffolder/templates/db_migrations/alembic/script.py.mako

@@ -0,0 +1,28 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    ${downgrades if downgrades else "pass"}