fapier 0.1.0__tar.gz

fapier-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: fapier
+Version: 0.1.0
+Summary: A command-line tool to scaffold and bootstrap FastAPI projects quickly.
+Author: Dahmoun Mouaine Aymen
+License: MIT
+Project-URL: Homepage, https://github.com/aymen-dahmoun/fapi
+Project-URL: Repository, https://github.com/aymen-dahmoun/fapi
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi
+Requires-Dist: uvicorn[standard]
+Requires-Dist: typer[all]
+Requires-Dist: jinja2
+Requires-Dist: sqlalchemy
+Requires-Dist: passlib[bcrypt]
+Requires-Dist: pydantic[email]
+Requires-Dist: python-dotenv
+Requires-Dist: pydantic-settings
+
+# FastAPI Project Generator CLI
+
+A CLI tool that scaffolds FastAPI projects with optional database and API structure.
+
+---
+
+## ✅ Features
+
+| Feature                    | Description                                     |
+| -------------------------- | ----------------------------------------------- |
+| Generate FastAPI project   | Creates a full FastAPI folder structure         |
+| Optional Database          | Create project with or without SQLAlchemy setup |
+| Auto-creates virtualenv    | Creates `.venv` inside the project              |
+| Auto-installs requirements | Installs dependencies based on options          |
+| Jinja2 Templates           | Clean and flexible template system              |
+| Developer friendly         | Simple prompts & automatic setup                |
+| CLI `add` commands         | Add routes, models, schemas, crud, services     |
+
+---
+
+## 📂 Project Output Structure
+
+When DB and routes are enabled:
+
+```
+project_name/
+ ├─ app/
+ │  ├─ main.py
+ │  ├─ core/
+ │  │   └─ config.py
+ │  ├─ models/
+ │  │   └─ user.py
+ │  ├─ schemas/
+ │  │   └─ user.py
+ │  ├─ crud/
+ │  │   └─ user.py
+ │  ├─ services/
+ │  │   └─ example.py
+ │  ├─ api/
+ │  │   └─ router.py
+ │  └─ __init__.py
+ ├─ .fastapi                  # internal flag to detect project
+ ├─ .env
+ ├─ requirements.txt
+ └─ .venv/
+```
+
+If database or routes are disabled, the tool skips those folders.
+
+---
+
+## 🧰 Installation
+
+### Clone Repo
+
+```bash
+git clone https://github.com/aymen-Dahmoun/FApi.git
+cd FApi
+```
+
+### Install dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+> Requires Python 3.10+
+
+---
+
+## 🚀 Usage
+
+### Create a project
+
+```bash
+python cli.py myproject
+```
+
+### Answer prompts
+
+Example interaction:
+
+```
+Do you want to use a DB? [y/n]: y
+Choose a Database (sqlite/postgres) [sqlite]: sqlite
+Do you want to generate routes? [y/n]: y
+```
+
+or simply run
+
+```bash
+python cli.py myproject --db sqlite --routes
+```
+
+### Add new components
+
+```bash
+fapi add route product
+fapi add model product --schema --crud
+fapi add service payment
+```
+
+> Auto-detects if you're inside a FastAPI project using `.fastapi`
+
+---
+
+## 🏁 Run the project
+
+```bash
+cd myproject
+source .venv/bin/activate   # Linux/Mac
+# or .venv\Scripts\activate on Windows
+
+uvicorn app.main:app --reload
+```
+
+---
+
+## 📌 Roadmap
+
+| Feature                | Status     |
+| ---------------------- | ---------- |
+| Basic FastAPI scaffold | ✅ Done     |
+| Optional DB            | ✅ Done     |
+| Optional API           | ✅ Done     |
+| `fapi add` commands    | ✅ Done     |
+| Auto router import     | 🔜 Planned |
+| Alembic migrations     | 🔜 Planned |
+| Docker support         | 🔜 Planned |
+| Publish on PyPI        | 🎯 Future  |
+
+---
+
+## 🤝 Contributing
+
+Pull requests are welcome! 👐
+
+---
+
+⭐ If you like this tool, give the repo a star!

fapier-0.1.0/README.md

@@ -0,0 +1,140 @@
+# FastAPI Project Generator CLI
+
+A CLI tool that scaffolds FastAPI projects with optional database and API structure.
+
+---
+
+## ✅ Features
+
+| Feature                    | Description                                     |
+| -------------------------- | ----------------------------------------------- |
+| Generate FastAPI project   | Creates a full FastAPI folder structure         |
+| Optional Database          | Create project with or without SQLAlchemy setup |
+| Auto-creates virtualenv    | Creates `.venv` inside the project              |
+| Auto-installs requirements | Installs dependencies based on options          |
+| Jinja2 Templates           | Clean and flexible template system              |
+| Developer friendly         | Simple prompts & automatic setup                |
+| CLI `add` commands         | Add routes, models, schemas, crud, services     |
+
+---
+
+## 📂 Project Output Structure
+
+When DB and routes are enabled:
+
+```
+project_name/
+ ├─ app/
+ │  ├─ main.py
+ │  ├─ core/
+ │  │   └─ config.py
+ │  ├─ models/
+ │  │   └─ user.py
+ │  ├─ schemas/
+ │  │   └─ user.py
+ │  ├─ crud/
+ │  │   └─ user.py
+ │  ├─ services/
+ │  │   └─ example.py
+ │  ├─ api/
+ │  │   └─ router.py
+ │  └─ __init__.py
+ ├─ .fastapi                  # internal flag to detect project
+ ├─ .env
+ ├─ requirements.txt
+ └─ .venv/
+```
+
+If database or routes are disabled, the tool skips those folders.
+
+---
+
+## 🧰 Installation
+
+### Clone Repo
+
+```bash
+git clone https://github.com/aymen-Dahmoun/FApi.git
+cd FApi
+```
+
+### Install dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+> Requires Python 3.10+
+
+---
+
+## 🚀 Usage
+
+### Create a project
+
+```bash
+python cli.py myproject
+```
+
+### Answer prompts
+
+Example interaction:
+
+```
+Do you want to use a DB? [y/n]: y
+Choose a Database (sqlite/postgres) [sqlite]: sqlite
+Do you want to generate routes? [y/n]: y
+```
+
+or simply run
+
+```bash
+python cli.py myproject --db sqlite --routes
+```
+
+### Add new components
+
+```bash
+fapi add route product
+fapi add model product --schema --crud
+fapi add service payment
+```
+
+> Auto-detects if you're inside a FastAPI project using `.fastapi`
+
+---
+
+## 🏁 Run the project
+
+```bash
+cd myproject
+source .venv/bin/activate   # Linux/Mac
+# or .venv\Scripts\activate on Windows
+
+uvicorn app.main:app --reload
+```
+
+---
+
+## 📌 Roadmap
+
+| Feature                | Status     |
+| ---------------------- | ---------- |
+| Basic FastAPI scaffold | ✅ Done     |
+| Optional DB            | ✅ Done     |
+| Optional API           | ✅ Done     |
+| `fapi add` commands    | ✅ Done     |
+| Auto router import     | 🔜 Planned |
+| Alembic migrations     | 🔜 Planned |
+| Docker support         | 🔜 Planned |
+| Publish on PyPI        | 🎯 Future  |
+
+---
+
+## 🤝 Contributing
+
+Pull requests are welcome! 👐
+
+---
+
+⭐ If you like this tool, give the repo a star!

fapier-0.1.0/fapi/cli.py

@@ -0,0 +1,10 @@
+import typer
+from fapi.commands.create import create_app
+from fapi.commands.add import add
+
+app = typer.Typer(help="FastAPI CLI Tool")
+app.add_typer(create_app)
+app.add_typer(add, name='add')
+
+if __name__ == "__main__":
+    app()

fapier-0.1.0/fapi/commands/add.py

@@ -0,0 +1,124 @@
+import typer
+from pathlib import Path
+from fapi.utils.ustils import render_template, ensure_fastapi_project
+
+add = typer.Typer(help="Adds entities like models, schemas, routes...")
+
+TEMPLATES_DIR = Path("fapi/templates")
+
+
+@add.command()
+def route(name: str):
+    """Create a new route file"""
+    ensure_fastapi_project()
+    if not name:
+        typer.echo("You must provide a name for the route")
+        raise typer.Exit()
+
+    project_path = Path(".")
+    context = {"name": name.lower(), "class_name": name.capitalize()}
+
+    routes_dir = project_path / "app/api/routes"
+    routes_dir.mkdir(parents=True, exist_ok=True)
+
+    render_template("app/api/routes/route.py.j2", routes_dir / f"{name.lower()}.py", context)
+
+    typer.echo(f"✅ Route `{name}` created successfully!")
+
+
+@add.command()
+def model(
+    name: str,
+    schema: bool = typer.Option(False, "--schema", help="Add a schema file"),
+    crud: bool = typer.Option(False, "--crud", help="Add a CRUD file")
+):
+    ensure_fastapi_project()
+    if not name:
+        typer.echo("You must provide a name for the model")
+        raise typer.Exit()
+
+    project_path = Path(".")
+    context = {"name": name.lower(), "class_name": name.capitalize()}
+
+    models_dir = project_path / "app/models"
+    models_dir.mkdir(parents=True, exist_ok=True)
+
+    render_template("app/models/model.py.j2", models_dir / f"{name.lower()}.py", context)
+
+    if schema:
+        schemas_dir = project_path / "app/schemas"
+        schemas_dir.mkdir(parents=True, exist_ok=True)
+
+        render_template("app/schemas/schema.py.j2", schemas_dir / f"{name.lower()}_schema.py", context)
+        typer.echo(f"📦 Schema `{name}` created")
+
+    if crud:
+        crud_dir = project_path / "app/crud"
+        crud_dir.mkdir(parents=True, exist_ok=True)
+
+        render_template("app/crud/crud.py.j2", crud_dir / f"{name.lower()}_crud.py", context)
+        typer.echo(f"🛠️ CRUD `{name}` created")
+
+    typer.echo(f"✅ Model `{name}` created successfully!")
+
+
+@add.command()
+def service(name: str):
+    """Create a new service file"""
+    ensure_fastapi_project()
+
+    if not name:
+        typer.echo("You must provide a name for the service")
+        raise typer.Exit()
+
+    project_path = Path(".")
+    context = {"name": name.lower()}
+
+    routes_dir = project_path / "app/services"
+    routes_dir.mkdir(parents=True, exist_ok=True)
+
+    render_template("app/services/service.py.j2", routes_dir / f"{name.lower()}.py", context)
+
+    typer.echo(f"✅ service `{name}` created successfully!")
+
+
+
+@add.command()
+def crud(name: str):
+    """Create a new crud file"""
+
+    ensure_fastapi_project()
+
+    if not name:
+        typer.echo("You must provide a name for the service")
+        raise typer.Exit()
+
+    project_path = Path(".")
+    context = {"name": name.lower()}
+
+    routes_dir = project_path / "app/crud"
+    routes_dir.mkdir(parents=True, exist_ok=True)
+
+    render_template("app/crud/crud.py.j2", routes_dir / f"{name.lower()}.py", context)
+
+    typer.echo(f"✅ crud `{name}` created successfully!")
+
+@add.command()
+def schema(name: str):
+    """Create a new schema file"""
+    
+    ensure_fastapi_project()
+
+    if not name:
+        typer.echo("You must provide a name for the service")
+        raise typer.Exit()
+
+    project_path = Path(".")
+    context = {"name": name.lower(), "class_name": name.capitalize()}
+
+    routes_dir = project_path / "app/schemas"
+    routes_dir.mkdir(parents=True, exist_ok=True)
+
+    render_template("app/schemas/schema.py.j2", routes_dir / f"{name.lower()}.py", context)
+
+    typer.echo(f"✅ schema `{name}` created successfully!")

fapier-0.1.0/fapi/commands/create.py

@@ -0,0 +1,86 @@
+import typer
+from fapi.utils.ustils import render_template, req_installer, create_venv
+from pathlib import Path
+create_app = typer.Typer(help="FastAPI project generator")
+
+
+@create_app.command()
+def create(
+    project_name: str = typer.Argument(...),
+    db: str = typer.Option(
+        None, "--db", help="Database: sqlite or postgres", case_sensitive=False
+    ),
+    routes: bool = typer.Option(
+        None, "--routes", help="Generate routes?"
+    ),
+):
+    """Create a new FastAPI project"""
+    project_dir = Path(project_name)
+
+    if project_dir.exists():
+        typer.echo(f"Directory {project_name} already exists!")
+        raise typer.Exit()
+
+    typer.echo(f"Creating FastAPI project: {project_name}... ✅")
+    if db is None:
+        use_db = typer.confirm("do you want to use a db?")
+        db_choice = typer.prompt("Choose a Database (sqlite/postgres)", default="sqlite") if use_db else None
+    else:
+        use_db = db.lower() in ["postgres", "sqlite"]
+        db_choice = db.lower()
+        if not use_db: 
+            typer.echo(f"Invalid DB option! {db} neither 'sqlite' not 'postgres")
+            raise typer.Exit() 
+
+    if routes is None:
+        use_routes = typer.confirm("do you want to generate routes?")
+    else:
+        use_routes = routes
+
+    
+
+    context = {"project_name": project_name, "use_db":use_db, "db_choice": db_choice, "use_routes": use_routes}
+
+    # Create folders
+    (project_dir / "app").mkdir(parents=True, exist_ok=True)
+
+    # Render templates
+    render_template("app/main.py.j2", project_dir / "app/main.py", context)
+    (project_dir / "app" / "core").mkdir()
+    render_template("app/core/config.py.j2", project_dir / "app/core/config.py", context)
+    if use_db:
+        (project_dir / "app" / "models").mkdir()
+        (project_dir / "app" / "schemas").mkdir()
+        (project_dir / "app" / "crud").mkdir()
+        render_template("app/crud/user.py.j2", project_dir / "app/crud/user.py", context)
+        render_template("app/core/database.py.j2", project_dir / "app/core/database.py", context)
+        render_template("app/models/user.py.j2", project_dir / "app/models/user.py", context)
+        render_template("app/schemas/user.py.j2", project_dir / "app/schemas/user.py", context)
+    if use_routes:
+        (project_dir / "app" / "api").mkdir()
+        (project_dir / "app" / "services").mkdir()
+        (project_dir / "app" / "api" / "routes").mkdir()
+        render_template("app/api/routes/user.py.j2", project_dir / "app/api/routes/user.py", context)
+        render_template("app/api/router.py.j2", project_dir / "app/api/router.py", context)
+        render_template("app/services/passwordHash.py.j2", project_dir / "app/services/passwordHash.py", context)
+    render_template("requirements.txt.j2", project_dir / "requirements.txt", context)
+    render_template("app/__init__.py.j2", project_dir / "app/__init__.py", context)
+    # Create .env example
+    (project_dir / ".env").write_text("APP_NAME=" + project_name)
+    create_venv(project_dir)
+    req_installer(project_dir)
+    (project_dir / ".fastapi").write_text("fastapi-project")
+
+
+    typer.echo("✅ Project created successfully!")
+    typer.echo(f"Next steps 👉 \n")
+    typer.echo(f"cd {project_name}")
+    typer.echo("""activate venv: 
+               linux / mac: source .venv/bin/activate
+                Windows (PowerShell):
+                .venv\\Scripts\\Activate.ps1
+
+                Windows (CMD):
+                .venv\\Scripts\\activate.bat
+               """)
+    typer.echo(f"uvicorn app.main:app --reload")

fapier-0.1.0/fapi/constants.py

@@ -0,0 +1,4 @@
+from pathlib import Path
+
+TEMPLATES_DIR = Path(__file__).parent / "templates"
+print(TEMPLATES_DIR)

fapier-0.1.0/fapi/utils/ustils.py

@@ -0,0 +1,32 @@
+import typer
+from pathlib import Path
+from jinja2 import Environment, FileSystemLoader
+import subprocess
+from fapi.constants import TEMPLATES_DIR
+
+
+def create_venv(project_dir: Path):
+    typer.echo("🛠 Creating virtual environment...")
+    subprocess.run(["python3", "-m", "venv", ".venv"], cwd=project_dir)
+
+
+def req_installer(project_dir: Path):
+    req_file = project_dir / "requirements.txt"
+    pip_path = project_dir / ".venv" / "bin" / "pip"
+
+    typer.echo("📦 Installing dependencies...")
+    subprocess.run([str(pip_path), "install", "-r", str(req_file)])
+
+def render_template(src, dest, context):
+    env = Environment(loader=FileSystemLoader(TEMPLATES_DIR))
+    template = env.get_template(src)
+    rendered = template.render(**context)
+
+    dest.parent.mkdir(parents=True, exist_ok=True)
+    dest.write_text(rendered)
+
+def ensure_fastapi_project():
+    if not Path(".fastapi").exists():
+        typer.echo("❌ This is not a FastAPI project generated by this CLI.")
+        typer.echo("Hint: Run `fapi create <project-name>` first.")
+        raise typer.Exit(1)

fapier-0.1.0/fapier.egg-info/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: fapier
+Version: 0.1.0
+Summary: A command-line tool to scaffold and bootstrap FastAPI projects quickly.
+Author: Dahmoun Mouaine Aymen
+License: MIT
+Project-URL: Homepage, https://github.com/aymen-dahmoun/fapi
+Project-URL: Repository, https://github.com/aymen-dahmoun/fapi
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi
+Requires-Dist: uvicorn[standard]
+Requires-Dist: typer[all]
+Requires-Dist: jinja2
+Requires-Dist: sqlalchemy
+Requires-Dist: passlib[bcrypt]
+Requires-Dist: pydantic[email]
+Requires-Dist: python-dotenv
+Requires-Dist: pydantic-settings
+
+# FastAPI Project Generator CLI
+
+A CLI tool that scaffolds FastAPI projects with optional database and API structure.
+
+---
+
+## ✅ Features
+
+| Feature                    | Description                                     |
+| -------------------------- | ----------------------------------------------- |
+| Generate FastAPI project   | Creates a full FastAPI folder structure         |
+| Optional Database          | Create project with or without SQLAlchemy setup |
+| Auto-creates virtualenv    | Creates `.venv` inside the project              |
+| Auto-installs requirements | Installs dependencies based on options          |
+| Jinja2 Templates           | Clean and flexible template system              |
+| Developer friendly         | Simple prompts & automatic setup                |
+| CLI `add` commands         | Add routes, models, schemas, crud, services     |
+
+---
+
+## 📂 Project Output Structure
+
+When DB and routes are enabled:
+
+```
+project_name/
+ ├─ app/
+ │  ├─ main.py
+ │  ├─ core/
+ │  │   └─ config.py
+ │  ├─ models/
+ │  │   └─ user.py
+ │  ├─ schemas/
+ │  │   └─ user.py
+ │  ├─ crud/
+ │  │   └─ user.py
+ │  ├─ services/
+ │  │   └─ example.py
+ │  ├─ api/
+ │  │   └─ router.py
+ │  └─ __init__.py
+ ├─ .fastapi                  # internal flag to detect project
+ ├─ .env
+ ├─ requirements.txt
+ └─ .venv/
+```
+
+If database or routes are disabled, the tool skips those folders.
+
+---
+
+## 🧰 Installation
+
+### Clone Repo
+
+```bash
+git clone https://github.com/aymen-Dahmoun/FApi.git
+cd FApi
+```
+
+### Install dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+> Requires Python 3.10+
+
+---
+
+## 🚀 Usage
+
+### Create a project
+
+```bash
+python cli.py myproject
+```
+
+### Answer prompts
+
+Example interaction:
+
+```
+Do you want to use a DB? [y/n]: y
+Choose a Database (sqlite/postgres) [sqlite]: sqlite
+Do you want to generate routes? [y/n]: y
+```
+
+or simply run
+
+```bash
+python cli.py myproject --db sqlite --routes
+```
+
+### Add new components
+
+```bash
+fapi add route product
+fapi add model product --schema --crud
+fapi add service payment
+```
+
+> Auto-detects if you're inside a FastAPI project using `.fastapi`
+
+---
+
+## 🏁 Run the project
+
+```bash
+cd myproject
+source .venv/bin/activate   # Linux/Mac
+# or .venv\Scripts\activate on Windows
+
+uvicorn app.main:app --reload
+```
+
+---
+
+## 📌 Roadmap
+
+| Feature                | Status     |
+| ---------------------- | ---------- |
+| Basic FastAPI scaffold | ✅ Done     |
+| Optional DB            | ✅ Done     |
+| Optional API           | ✅ Done     |
+| `fapi add` commands    | ✅ Done     |
+| Auto router import     | 🔜 Planned |
+| Alembic migrations     | 🔜 Planned |
+| Docker support         | 🔜 Planned |
+| Publish on PyPI        | 🎯 Future  |
+
+---
+
+## 🤝 Contributing
+
+Pull requests are welcome! 👐
+
+---
+
+⭐ If you like this tool, give the repo a star!

fapier-0.1.0/fapier.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+pyproject.toml
+fapi/__init__.py
+fapi/cli.py
+fapi/constants.py
+fapi/commands/__init__.py
+fapi/commands/add.py
+fapi/commands/create.py
+fapi/utils/__init__.py
+fapi/utils/ustils.py
+fapier.egg-info/PKG-INFO
+fapier.egg-info/SOURCES.txt
+fapier.egg-info/dependency_links.txt
+fapier.egg-info/entry_points.txt
+fapier.egg-info/requires.txt
+fapier.egg-info/top_level.txt

fapier-0.1.0/fapier.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fapier-0.1.0/fapier.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fapi = fapi.cli:app

fapier-0.1.0/fapier.egg-info/requires.txt

@@ -0,0 +1,9 @@
+fastapi
+uvicorn[standard]
+typer[all]
+jinja2
+sqlalchemy
+passlib[bcrypt]
+pydantic[email]
+python-dotenv
+pydantic-settings

fapier-0.1.0/fapier.egg-info/top_level.txt

@@ -0,0 +1 @@
+fapi

fapier-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fapier"
+version = "0.1.0"
+description = "A command-line tool to scaffold and bootstrap FastAPI projects quickly."
+readme = "README.md"
+authors = [
+    { name = "Dahmoun Mouaine Aymen" }
+]
+license = { text = "MIT" }
+requires-python = ">=3.10"
+
+dependencies = [
+    "fastapi",
+    "uvicorn[standard]",
+    "typer[all]",
+    "jinja2",
+    "sqlalchemy",
+    "passlib[bcrypt]",
+    "pydantic[email]",
+    "python-dotenv",
+    "pydantic-settings"
+]
+
+[project.urls]
+Homepage = "https://github.com/aymen-dahmoun/fapi"
+Repository = "https://github.com/aymen-dahmoun/fapi"
+
+[project.scripts]
+fapi = "fapi.cli:app"

fapier-0.1.0/setup.cfg

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