plinth-cli 1.0.0__tar.gz → 1.0.2__tar.gz

plinth_cli-1.0.2/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: plinth-cli
+Version: 1.0.2
+Summary: Scaffold FastAPI projects in seconds, add features as you grow
+Project-URL: Homepage, https://github.com/cybertycoon/plinth
+Project-URL: Documentation, https://github.com/cybertycoon/plinth/blob/main/docs
+Project-URL: Repository, https://github.com/cybertycoon/plinth.git
+Project-URL: Issues, https://github.com/cybertycoon/plinth/issues
+Project-URL: Changelog, https://github.com/cybertycoon/plinth/blob/main/CHANGELOG.md
+Author-email: Silas Okanlawon <okanlawonsilas@gmail.com>
+License: MIT
+Keywords: api,cli,fastapi,framework,generator,scaffolding,web
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: libcst>=1.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: toml>=0.10.2
+Requires-Dist: typer[all]>=0.12.0
+Description-Content-Type: text/markdown
+
+# 🪨 Plinth
+
+> Stop building the "basement" of your FastAPI project.
+
+## The Problem
+
+Every new FastAPI project starts with the same 2-hour slog:
+
+- Wiring up SQLAlchemy with async drivers
+- Setting up config management
+- Creating folder structures that won't become a mess
+- Adding auth... then rewriting it when you change your mind
+
+**Boilerplate burnout is real.**
+
+## The Solution
+
+Plinth scaffolds production-ready FastAPI projects in **2 seconds**, then lets you add features incrementally without breaking your code.
+
+```bash
+# Start with exactly what you need
+plinth init my-api --db postgres --auth jwt
+
+# Change your mind later? No problem.
+plinth add redis
+plinth add auth-session
+```
+
+## Why Plinth?
+
+| Without Plinth                                | With Plinth                                    |
+| --------------------------------------------- | ---------------------------------------------- |
+| Copy-paste boilerplate from old projects      | Generate clean, consistent structure instantly |
+| Fear of adding features mid-project           | Add/remove modules anytime safely              |
+| Hope your code injection doesn't break things | AST-aware code modifications (LibCST)          |
+| Spend hours on setup                          | Spend hours on **features**                    |
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install plinth-cli
+```
+
+### Install with uv (Faster)
+
+```bash
+uv tool install plinth-cli
+```
+
+### From Source
+
+```bash
+git clone https://github.com/cybertycoon/plinth.git
+cd plinth
+pip install -r requirements.txt
+pip install -e .
+```
+
+## Quick Start
+
+### Create a Basic Project
+
+```bash
+plinth init my-app
+cd my-app
+uv run uvicorn src.main:app --reload
+```
+
+### Create with Database & Auth
+
+```bash
+plinth init my-api --db postgres --auth jwt --redis
+```
+
+### Add Features Later
+
+```bash
+cd my-api
+
+# Add Redis caching
+plinth add redis
+
+# Add JWT authentication
+plinth add auth-jwt
+```
+
+## Commands
+
+### `plinth init <name>` — Create New Project
+
+Scaffold a new FastAPI project with your chosen features.
+
+```bash
+# Basic project
+plinth init my-app
+
+# With database and auth
+plinth init my-api --db postgres --auth jwt
+
+# Full stack
+plinth init my-service --db postgres --redis --auth jwt
+```
+
+**Options:**
+
+- `--db postgres|mysql|sqlite` — Add database support
+- `--redis` — Add Redis caching
+- `--auth jwt|session` — Add authentication
+
+### `plinth add <module>` — Add Features Later
+
+Add modules to an existing project without breaking your code.
+
+```bash
+cd my-api
+
+# Add Redis for caching
+plinth add redis
+
+# Add JWT authentication
+plinth add auth-jwt
+
+# Add database (if not added during init)
+plinth add postgres
+```
+
+### `plinth remove <module>` — Remove Features
+
+Cleanly remove a module and its code.
+
+```bash
+plinth remove redis
+plinth remove auth-jwt
+```
+
+### `plinth list` — See What's Available
+
+Shows installed modules and available modules you can add.
+
+```bash
+plinth list
+```
+
+### `plinth doctor` — Check Project Health
+
+Diagnoses issues with your Plinth project.
+
+```bash
+plinth doctor
+```
+
+## Available Modules
+
+- **postgres/mysql/sqlite** - Database with async drivers
+- **redis** - Caching & sessions
+- **auth-jwt** - JWT authentication
+- **auth-session** - Session-based auth
+
+## How It Works
+
+Plinth doesn't just copy files—it **understands** your Python code using AST manipulation. When you run `plinth add redis`, it:
+
+1. Injects Redis connection code into your main app
+2. Updates `.env` with Redis URL
+3. Adds dependencies to `pyproject.toml`
+4. Registers routes without touching your custom code
+
+Your project stays clean, typed, and maintainable.
+
+## Project Structure
+
+```
+my-app/
+├── src/
+│   ├── __init__.py       # Package initializer
+│   ├── main.py           # FastAPI entry
+│   ├── api/
+│   │   ├── __init__.py
+│   │   └── v1/
+│   │       ├── __init__.py
+│   │       └── health.py
+│   ├── core/
+│   │   ├── __init__.py
+│   │   ├── config.py     # Pydantic settings
+│   │   ├── database.py   # Database connection (if DB selected)
+│   │   └── registry.py   # Auto-router registration
+│   └── models/
+│       └── __init__.py
+├── tests/
+│   └── __init__.py
+├── .env.example          # Environment template
+├── .gitignore           # Git ignore rules
+├── .plinth.json         # Tracks installed modules
+├── pyproject.toml       # Dependencies
+└── README.md            # Project readme
+```
+
+## Documentation
+
+- [Complete User Guide](docs/plinth-complete-guide.md)
+- [Developer Guide](docs/developer-guide.md)
+
+## License
+
+MIT License

plinth_cli-1.0.2/README.md

@@ -0,0 +1,207 @@
+# 🪨 Plinth
+
+> Stop building the "basement" of your FastAPI project.
+
+## The Problem
+
+Every new FastAPI project starts with the same 2-hour slog:
+
+- Wiring up SQLAlchemy with async drivers
+- Setting up config management
+- Creating folder structures that won't become a mess
+- Adding auth... then rewriting it when you change your mind
+
+**Boilerplate burnout is real.**
+
+## The Solution
+
+Plinth scaffolds production-ready FastAPI projects in **2 seconds**, then lets you add features incrementally without breaking your code.
+
+```bash
+# Start with exactly what you need
+plinth init my-api --db postgres --auth jwt
+
+# Change your mind later? No problem.
+plinth add redis
+plinth add auth-session
+```
+
+## Why Plinth?
+
+| Without Plinth                                | With Plinth                                    |
+| --------------------------------------------- | ---------------------------------------------- |
+| Copy-paste boilerplate from old projects      | Generate clean, consistent structure instantly |
+| Fear of adding features mid-project           | Add/remove modules anytime safely              |
+| Hope your code injection doesn't break things | AST-aware code modifications (LibCST)          |
+| Spend hours on setup                          | Spend hours on **features**                    |
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install plinth-cli
+```
+
+### Install with uv (Faster)
+
+```bash
+uv tool install plinth-cli
+```
+
+### From Source
+
+```bash
+git clone https://github.com/cybertycoon/plinth.git
+cd plinth
+pip install -r requirements.txt
+pip install -e .
+```
+
+## Quick Start
+
+### Create a Basic Project
+
+```bash
+plinth init my-app
+cd my-app
+uv run uvicorn src.main:app --reload
+```
+
+### Create with Database & Auth
+
+```bash
+plinth init my-api --db postgres --auth jwt --redis
+```
+
+### Add Features Later
+
+```bash
+cd my-api
+
+# Add Redis caching
+plinth add redis
+
+# Add JWT authentication
+plinth add auth-jwt
+```
+
+## Commands
+
+### `plinth init <name>` — Create New Project
+
+Scaffold a new FastAPI project with your chosen features.
+
+```bash
+# Basic project
+plinth init my-app
+
+# With database and auth
+plinth init my-api --db postgres --auth jwt
+
+# Full stack
+plinth init my-service --db postgres --redis --auth jwt
+```
+
+**Options:**
+
+- `--db postgres|mysql|sqlite` — Add database support
+- `--redis` — Add Redis caching
+- `--auth jwt|session` — Add authentication
+
+### `plinth add <module>` — Add Features Later
+
+Add modules to an existing project without breaking your code.
+
+```bash
+cd my-api
+
+# Add Redis for caching
+plinth add redis
+
+# Add JWT authentication
+plinth add auth-jwt
+
+# Add database (if not added during init)
+plinth add postgres
+```
+
+### `plinth remove <module>` — Remove Features
+
+Cleanly remove a module and its code.
+
+```bash
+plinth remove redis
+plinth remove auth-jwt
+```
+
+### `plinth list` — See What's Available
+
+Shows installed modules and available modules you can add.
+
+```bash
+plinth list
+```
+
+### `plinth doctor` — Check Project Health
+
+Diagnoses issues with your Plinth project.
+
+```bash
+plinth doctor
+```
+
+## Available Modules
+
+- **postgres/mysql/sqlite** - Database with async drivers
+- **redis** - Caching & sessions
+- **auth-jwt** - JWT authentication
+- **auth-session** - Session-based auth
+
+## How It Works
+
+Plinth doesn't just copy files—it **understands** your Python code using AST manipulation. When you run `plinth add redis`, it:
+
+1. Injects Redis connection code into your main app
+2. Updates `.env` with Redis URL
+3. Adds dependencies to `pyproject.toml`
+4. Registers routes without touching your custom code
+
+Your project stays clean, typed, and maintainable.
+
+## Project Structure
+
+```
+my-app/
+├── src/
+│   ├── __init__.py       # Package initializer
+│   ├── main.py           # FastAPI entry
+│   ├── api/
+│   │   ├── __init__.py
+│   │   └── v1/
+│   │       ├── __init__.py
+│   │       └── health.py
+│   ├── core/
+│   │   ├── __init__.py
+│   │   ├── config.py     # Pydantic settings
+│   │   ├── database.py   # Database connection (if DB selected)
+│   │   └── registry.py   # Auto-router registration
+│   └── models/
+│       └── __init__.py
+├── tests/
+│   └── __init__.py
+├── .env.example          # Environment template
+├── .gitignore           # Git ignore rules
+├── .plinth.json         # Tracks installed modules
+├── pyproject.toml       # Dependencies
+└── README.md            # Project readme
+```
+
+## Documentation
+
+- [Complete User Guide](docs/plinth-complete-guide.md)
+- [Developer Guide](docs/developer-guide.md)
+
+## License
+
+MIT License

{plinth_cli-1.0.0 → plinth_cli-1.0.2}/docs/plinth-complete-guide.md

@@ -17,15 +17,17 @@ Plinth is a tool that creates FastAPI projects with the features you need. Inste
 ### Option 1: Install from PyPI (Recommended)
 
 ```bash
-pip install plinth
+pip install plinth-cli
 ```
 
 ### Option 2: Install with uv (Faster)
 
 ```bash
-uv tool install plinth
+uv tool install plinth-cli
 ```
 
+> **Note:** The package is named `plinth-cli` on PyPI, but the command remains `plinth`.
+
 ### Verify Installation
 
 ```bash
@@ -143,15 +145,26 @@ After running `plinth init`, you get:
 ```
 my-app/
 ├── src/
+│   ├── __init__.py      # Package initializer
 │   ├── main.py          # API entry point
+│   ├── api/
+│   │   ├── __init__.py
+│   │   └── v1/
+│   │       ├── __init__.py
+│   │       └── health.py
 │   ├── core/
-│   │   ├── config.py    # Settings
+│   │   ├── __init__.py
+│   │   ├── config.py    # Application settings
+│   │   ├── database.py  # Database connection (if DB selected)
 │   │   └── registry.py  # Route registration
-│   └── api/
-│       └── v1/
-│           └── health.py
+│   └── models/
+│       └── __init__.py
+├── tests/
+│   └── __init__.py
 ├── .env.example         # Environment template
+├── .gitignore          # Git ignore rules
 ├── pyproject.toml       # Dependencies
+├── README.md            # Project readme
 └── .plinth.json         # Plinth state
 ```
 

{plinth_cli-1.0.0 → plinth_cli-1.0.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "plinth-cli"
-version = "1.0.0"
-description = "A high-performance, developer-first CLI scaffolding tool for FastAPI"
+version = "1.0.2"
+description = "Scaffold FastAPI projects in seconds, add features as you grow"
 readme = "README.md"
 license = {text = "MIT"}
 requires-python = ">=3.10"

{plinth_cli-1.0.0 → plinth_cli-1.0.2}/src/plinth/__init__.py

@@ -1,3 +1,3 @@
 """Plinth: A high-performance CLI scaffolding tool for FastAPI."""
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"

plinth_cli-1.0.2/src/plinth/templates/base/.env.local

@@ -0,0 +1 @@
+PY_TOKEN=pypi-AgEIcHlwaS5vcmcCJDAzYjY5ZmI4LTE4YzUtNGRlZC1hOTVmLWRhNTQwYWIwMWRkNQACElsxLFsicGxpbnRoLWNsaSJdXQACLFsyLFsiZTc4YzMyMjUtZmY1My00NGYxLTgxZWMtODRjN2Q5ZDRiNDBiIl1dAAAGIAYnkejQ7ggiW28d2f5gyBlRmKvtUGxcduSqKY19-Ahl

{plinth_cli-1.0.0 → plinth_cli-1.0.2}/src/plinth/templates/base/README.md.j2

@@ -19,17 +19,27 @@ The API will be available at `http://localhost:8000`.
 ```
 {{ project_name }}/
 ├── src/
+│   ├── __init__.py          # Package initializer
 │   ├── main.py              # FastAPI application entry point
 │   ├── core/
+│   │   ├── __init__.py
 │   │   ├── config.py        # Application settings
+│   │   ├── database.py      # Database connection (if DB selected)
 │   │   └── registry.py      # Router registry
 │   ├── api/
+│   │   ├── __init__.py
 │   │   └── v1/
+│   │       ├── __init__.py
 │   │       └── health.py    # Health check endpoints
 │   └── models/              # Database models
+│       └── __init__.py
 ├── tests/                   # Test suite
+│   └── __init__.py
 ├── pyproject.toml           # Project dependencies
-└── .env                     # Environment variables (create from .env.example)
+├── .env.example             # Environment template
+├── .gitignore              # Git ignore rules
+├── .plinth.json            # Plinth state
+└── README.md               # Project readme
 ```
 
 ## Configuration

plinth_cli-1.0.0/PKG-INFO

@@ -1,166 +0,0 @@
-Metadata-Version: 2.4
-Name: plinth-cli
-Version: 1.0.0
-Summary: A high-performance, developer-first CLI scaffolding tool for FastAPI
-Project-URL: Homepage, https://github.com/cybertycoon/plinth
-Project-URL: Documentation, https://github.com/cybertycoon/plinth/blob/main/docs
-Project-URL: Repository, https://github.com/cybertycoon/plinth.git
-Project-URL: Issues, https://github.com/cybertycoon/plinth/issues
-Project-URL: Changelog, https://github.com/cybertycoon/plinth/blob/main/CHANGELOG.md
-Author-email: Silas Okanlawon <okanlawonsilas@gmail.com>
-License: MIT
-Keywords: api,cli,fastapi,framework,generator,scaffolding,web
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Code Generators
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Typing :: Typed
-Requires-Python: >=3.10
-Requires-Dist: jinja2>=3.1.0
-Requires-Dist: libcst>=1.0.0
-Requires-Dist: pydantic-settings>=2.0.0
-Requires-Dist: pydantic>=2.0.0
-Requires-Dist: rich>=13.0.0
-Requires-Dist: toml>=0.10.2
-Requires-Dist: typer[all]>=0.12.0
-Description-Content-Type: text/markdown
-
-# 🪨 Plinth
-
-> A high-performance, developer-first CLI scaffolding tool for FastAPI
-
-## Overview
-
-Plinth is a dynamic CLI scaffolding engine for FastAPI that provides a rock-solid foundation for modern web APIs. Unlike static boilerplates, Plinth generates code based on your specific needs and allows you to evolve your project over time.
-
-## Features
-
-- 🚀 **Fast Project Initialization** - Create a new FastAPI project in seconds
-- 🔧 **Modular Architecture** - Add features (Auth, Redis, Database) as needed
-- 📝 **Type-Safe** - Built with Pydantic and Typer
-- 🎨 **Beautiful CLI** - Rich terminal output with progress bars
-- 🔒 **Safe Code Injection** - LibCST ensures safe AST modifications
-- 📦 **uv Integration** - Native support for fast Python package management
-
-## Installation
-
-### From Source
-
-```bash
-# Clone the repository
-git clone <repository-url>
-cd plinth
-
-# Install dependencies
-pip install -r requirements.txt
-
-# Install in development mode
-pip install -e .
-```
-
-### Using pip
-
-```bash
-pip install plinth
-```
-
-## Quick Start
-
-### Create a Basic Project
-
-```bash
-plinth init my-app
-cd my-app
-uv run uvicorn src.main:app --reload
-```
-
-### Create with Database
-
-```bash
-plinth init my-api --db postgres --auth jwt --redis
-```
-
-### Add Features Later
-
-```bash
-cd my-api
-
-# Add Redis caching
-plinth add redis
-
-# Add JWT authentication
-plinth add auth-jwt
-```
-
-## Commands
-
-| Command                  | Description                          |
-| ------------------------ | ------------------------------------ |
-| `plinth init <name>`     | Initialize a new FastAPI project     |
-| `plinth add <module>`    | Add a feature module                 |
-| `plinth remove <module>` | Remove a feature module              |
-| `plinth list`            | List installed and available modules |
-| `plinth doctor`          | Run diagnostics on the project       |
-
-## Available Modules
-
-- **postgres** - PostgreSQL database with asyncpg driver
-- **mysql** - MySQL database with aiomysql driver
-- **sqlite** - SQLite database with aiosqlite driver
-- **redis** - Redis caching and session storage
-- **auth-jwt** - JWT-based authentication
-- **auth-session** - Session-based authentication
-
-## Project Structure
-
-```
-my-app/
-├── .plinth.json          # State tracking
-├── pyproject.toml        # Dependencies
-├── src/
-│   ├── main.py          # FastAPI entry point
-│   ├── core/
-│   │   ├── config.py    # Settings
-│   │   └── registry.py  # Router registry
-│   └── api/
-│       └── v1/
-│           └── health.py
-└── tests/
-```
-
-## Development
-
-### Running Tests
-
-```bash
-pytest
-```
-
-### Code Quality
-
-```bash
-# Format code
-ruff format .
-
-# Lint code
-ruff check .
-
-# Type check
-mypy src/
-```
-
-## Documentation
-
-See the [complete guide](docs/plinth-complete-guide.md) for detailed documentation.
-
-## License
-
-MIT License

plinth_cli-1.0.0/README.md

@@ -1,131 +0,0 @@
-# 🪨 Plinth
-
-> A high-performance, developer-first CLI scaffolding tool for FastAPI
-
-## Overview
-
-Plinth is a dynamic CLI scaffolding engine for FastAPI that provides a rock-solid foundation for modern web APIs. Unlike static boilerplates, Plinth generates code based on your specific needs and allows you to evolve your project over time.
-
-## Features
-
-- 🚀 **Fast Project Initialization** - Create a new FastAPI project in seconds
-- 🔧 **Modular Architecture** - Add features (Auth, Redis, Database) as needed
-- 📝 **Type-Safe** - Built with Pydantic and Typer
-- 🎨 **Beautiful CLI** - Rich terminal output with progress bars
-- 🔒 **Safe Code Injection** - LibCST ensures safe AST modifications
-- 📦 **uv Integration** - Native support for fast Python package management
-
-## Installation
-
-### From Source
-
-```bash
-# Clone the repository
-git clone <repository-url>
-cd plinth
-
-# Install dependencies
-pip install -r requirements.txt
-
-# Install in development mode
-pip install -e .
-```
-
-### Using pip
-
-```bash
-pip install plinth
-```
-
-## Quick Start
-
-### Create a Basic Project
-
-```bash
-plinth init my-app
-cd my-app
-uv run uvicorn src.main:app --reload
-```
-
-### Create with Database
-
-```bash
-plinth init my-api --db postgres --auth jwt --redis
-```
-
-### Add Features Later
-
-```bash
-cd my-api
-
-# Add Redis caching
-plinth add redis
-
-# Add JWT authentication
-plinth add auth-jwt
-```
-
-## Commands
-
-| Command                  | Description                          |
-| ------------------------ | ------------------------------------ |
-| `plinth init <name>`     | Initialize a new FastAPI project     |
-| `plinth add <module>`    | Add a feature module                 |
-| `plinth remove <module>` | Remove a feature module              |
-| `plinth list`            | List installed and available modules |
-| `plinth doctor`          | Run diagnostics on the project       |
-
-## Available Modules
-
-- **postgres** - PostgreSQL database with asyncpg driver
-- **mysql** - MySQL database with aiomysql driver
-- **sqlite** - SQLite database with aiosqlite driver
-- **redis** - Redis caching and session storage
-- **auth-jwt** - JWT-based authentication
-- **auth-session** - Session-based authentication
-
-## Project Structure
-
-```
-my-app/
-├── .plinth.json          # State tracking
-├── pyproject.toml        # Dependencies
-├── src/
-│   ├── main.py          # FastAPI entry point
-│   ├── core/
-│   │   ├── config.py    # Settings
-│   │   └── registry.py  # Router registry
-│   └── api/
-│       └── v1/
-│           └── health.py
-└── tests/
-```
-
-## Development
-
-### Running Tests
-
-```bash
-pytest
-```
-
-### Code Quality
-
-```bash
-# Format code
-ruff format .
-
-# Lint code
-ruff check .
-
-# Type check
-mypy src/
-```
-
-## Documentation
-
-See the [complete guide](docs/plinth-complete-guide.md) for detailed documentation.
-
-## License
-
-MIT License