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

plinth_cli-1.0.3/LICENSE

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

{plinth_cli-1.0.2 → plinth_cli-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plinth-cli
-Version: 1.0.2
+Version: 1.0.3
 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
@@ -8,7 +8,28 @@ 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
+License: MIT License
+        
+        Copyright (c) 2026 Plinth Contributors
+        
+        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.
+License-File: LICENSE
 Keywords: api,cli,fastapi,framework,generator,scaffolding,web
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
@@ -33,7 +54,9 @@ Requires-Dist: toml>=0.10.2
 Requires-Dist: typer[all]>=0.12.0
 Description-Content-Type: text/markdown
 
-# 🪨 Plinth
+# 🪨 Plinth-CLI
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
 > Stop building the "basement" of your FastAPI project.
 
@@ -50,20 +73,20 @@ Every new FastAPI project starts with the same 2-hour slog:
 
 ## The Solution
 
-Plinth scaffolds production-ready FastAPI projects in **2 seconds**, then lets you add features incrementally without breaking your code.
+Plinth-CLI 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
+plinth-cli init my-api --db postgres --auth jwt
 
 # Change your mind later? No problem.
-plinth add redis
-plinth add auth-session
+plinth-cli add redis
+plinth-cli add auth-session
 ```
 
-## Why Plinth?
+## Why Plinth-CLI?
 
-| Without Plinth                                | With Plinth                                    |
+| Without Plinth-CLI                            | With Plinth-CLI                                |
 | --------------------------------------------- | ---------------------------------------------- |
 | Copy-paste boilerplate from old projects      | Generate clean, consistent structure instantly |
 | Fear of adding features mid-project           | Add/remove modules anytime safely              |
@@ -88,7 +111,7 @@ uv tool install plinth-cli
 
 ```bash
 git clone https://github.com/cybertycoon/plinth.git
-cd plinth
+cd plinth-cli
 pip install -r requirements.txt
 pip install -e .
 ```
@@ -98,7 +121,7 @@ pip install -e .
 ### Create a Basic Project
 
 ```bash
-plinth init my-app
+plinth-cli init my-app
 cd my-app
 uv run uvicorn src.main:app --reload
 ```
@@ -106,7 +129,7 @@ uv run uvicorn src.main:app --reload
 ### Create with Database & Auth
 
 ```bash
-plinth init my-api --db postgres --auth jwt --redis
+plinth-cli init my-api --db postgres --auth jwt --redis
 ```
 
 ### Add Features Later
@@ -115,27 +138,27 @@ plinth init my-api --db postgres --auth jwt --redis
 cd my-api
 
 # Add Redis caching
-plinth add redis
+plinth-cli add redis
 
 # Add JWT authentication
-plinth add auth-jwt
+plinth-cli add auth-jwt
 ```
 
 ## Commands
 
-### `plinth init <name>` — Create New Project
+### `plinth-cli init <name>` — Create New Project
 
 Scaffold a new FastAPI project with your chosen features.
 
 ```bash
 # Basic project
-plinth init my-app
+plinth-cli init my-app
 
 # With database and auth
-plinth init my-api --db postgres --auth jwt
+plinth-cli init my-api --db postgres --auth jwt
 
 # Full stack
-plinth init my-service --db postgres --redis --auth jwt
+plinth-cli init my-service --db postgres --redis --auth jwt
 ```
 
 **Options:**
@@ -144,7 +167,7 @@ plinth init my-service --db postgres --redis --auth jwt
 - `--redis` — Add Redis caching
 - `--auth jwt|session` — Add authentication
 
-### `plinth add <module>` — Add Features Later
+### `plinth-cli add <module>` — Add Features Later
 
 Add modules to an existing project without breaking your code.
 
@@ -152,38 +175,38 @@ Add modules to an existing project without breaking your code.
 cd my-api
 
 # Add Redis for caching
-plinth add redis
+plinth-cli add redis
 
 # Add JWT authentication
-plinth add auth-jwt
+plinth-cli add auth-jwt
 
 # Add database (if not added during init)
-plinth add postgres
+plinth-cli add postgres
 ```
 
-### `plinth remove <module>` — Remove Features
+### `plinth-cli remove <module>` — Remove Features
 
 Cleanly remove a module and its code.
 
 ```bash
-plinth remove redis
-plinth remove auth-jwt
+plinth-cli remove redis
+plinth-cli remove auth-jwt
 ```
 
-### `plinth list` — See What's Available
+### `plinth-cli list` — See What's Available
 
 Shows installed modules and available modules you can add.
 
 ```bash
-plinth list
+plinth-cli list
 ```
 
-### `plinth doctor` — Check Project Health
+### `plinth-cli doctor` — Check Project Health
 
-Diagnoses issues with your Plinth project.
+Diagnoses issues with your Plinth-CLI project.
 
 ```bash
-plinth doctor
+plinth-cli doctor
 ```
 
 ## Available Modules
@@ -195,7 +218,7 @@ plinth doctor
 
 ## How It Works
 
-Plinth doesn't just copy files—it **understands** your Python code using AST manipulation. When you run `plinth add redis`, it:
+Plinth-CLI doesn't just copy files—it **understands** your Python code using AST manipulation. When you run `plinth-cli add redis`, it:
 
 1. Injects Redis connection code into your main app
 2. Updates `.env` with Redis URL
@@ -234,8 +257,9 @@ my-app/
 
 ## Documentation
 
-- [Complete User Guide](docs/plinth-complete-guide.md)
-- [Developer Guide](docs/developer-guide.md)
+- [Complete User Guide](https://github.com/CyberTycoon/plinth/blob/main/docs/plinth-complete-guide.md)
+- [Developer Guide](https://github.com/CyberTycoon/plinth/blob/main/docs/developer-guide.md)
+- [Roadmap](https://github.com/CyberTycoon/plinth/blob/main/ROADMAP.md)
 
 ## License
 

{plinth_cli-1.0.2 → plinth_cli-1.0.3}/README.md

@@ -1,4 +1,6 @@
-# 🪨 Plinth
+# 🪨 Plinth-CLI
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
 > Stop building the "basement" of your FastAPI project.
 
@@ -15,20 +17,20 @@ Every new FastAPI project starts with the same 2-hour slog:
 
 ## The Solution
 
-Plinth scaffolds production-ready FastAPI projects in **2 seconds**, then lets you add features incrementally without breaking your code.
+Plinth-CLI 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
+plinth-cli init my-api --db postgres --auth jwt
 
 # Change your mind later? No problem.
-plinth add redis
-plinth add auth-session
+plinth-cli add redis
+plinth-cli add auth-session
 ```
 
-## Why Plinth?
+## Why Plinth-CLI?
 
-| Without Plinth                                | With Plinth                                    |
+| Without Plinth-CLI                            | With Plinth-CLI                                |
 | --------------------------------------------- | ---------------------------------------------- |
 | Copy-paste boilerplate from old projects      | Generate clean, consistent structure instantly |
 | Fear of adding features mid-project           | Add/remove modules anytime safely              |
@@ -53,7 +55,7 @@ uv tool install plinth-cli
 
 ```bash
 git clone https://github.com/cybertycoon/plinth.git
-cd plinth
+cd plinth-cli
 pip install -r requirements.txt
 pip install -e .
 ```
@@ -63,7 +65,7 @@ pip install -e .
 ### Create a Basic Project
 
 ```bash
-plinth init my-app
+plinth-cli init my-app
 cd my-app
 uv run uvicorn src.main:app --reload
 ```
@@ -71,7 +73,7 @@ uv run uvicorn src.main:app --reload
 ### Create with Database & Auth
 
 ```bash
-plinth init my-api --db postgres --auth jwt --redis
+plinth-cli init my-api --db postgres --auth jwt --redis
 ```
 
 ### Add Features Later
@@ -80,27 +82,27 @@ plinth init my-api --db postgres --auth jwt --redis
 cd my-api
 
 # Add Redis caching
-plinth add redis
+plinth-cli add redis
 
 # Add JWT authentication
-plinth add auth-jwt
+plinth-cli add auth-jwt
 ```
 
 ## Commands
 
-### `plinth init <name>` — Create New Project
+### `plinth-cli init <name>` — Create New Project
 
 Scaffold a new FastAPI project with your chosen features.
 
 ```bash
 # Basic project
-plinth init my-app
+plinth-cli init my-app
 
 # With database and auth
-plinth init my-api --db postgres --auth jwt
+plinth-cli init my-api --db postgres --auth jwt
 
 # Full stack
-plinth init my-service --db postgres --redis --auth jwt
+plinth-cli init my-service --db postgres --redis --auth jwt
 ```
 
 **Options:**
@@ -109,7 +111,7 @@ plinth init my-service --db postgres --redis --auth jwt
 - `--redis` — Add Redis caching
 - `--auth jwt|session` — Add authentication
 
-### `plinth add <module>` — Add Features Later
+### `plinth-cli add <module>` — Add Features Later
 
 Add modules to an existing project without breaking your code.
 
@@ -117,38 +119,38 @@ Add modules to an existing project without breaking your code.
 cd my-api
 
 # Add Redis for caching
-plinth add redis
+plinth-cli add redis
 
 # Add JWT authentication
-plinth add auth-jwt
+plinth-cli add auth-jwt
 
 # Add database (if not added during init)
-plinth add postgres
+plinth-cli add postgres
 ```
 
-### `plinth remove <module>` — Remove Features
+### `plinth-cli remove <module>` — Remove Features
 
 Cleanly remove a module and its code.
 
 ```bash
-plinth remove redis
-plinth remove auth-jwt
+plinth-cli remove redis
+plinth-cli remove auth-jwt
 ```
 
-### `plinth list` — See What's Available
+### `plinth-cli list` — See What's Available
 
 Shows installed modules and available modules you can add.
 
 ```bash
-plinth list
+plinth-cli list
 ```
 
-### `plinth doctor` — Check Project Health
+### `plinth-cli doctor` — Check Project Health
 
-Diagnoses issues with your Plinth project.
+Diagnoses issues with your Plinth-CLI project.
 
 ```bash
-plinth doctor
+plinth-cli doctor
 ```
 
 ## Available Modules
@@ -160,7 +162,7 @@ plinth doctor
 
 ## How It Works
 
-Plinth doesn't just copy files—it **understands** your Python code using AST manipulation. When you run `plinth add redis`, it:
+Plinth-CLI doesn't just copy files—it **understands** your Python code using AST manipulation. When you run `plinth-cli add redis`, it:
 
 1. Injects Redis connection code into your main app
 2. Updates `.env` with Redis URL
@@ -199,8 +201,9 @@ my-app/
 
 ## Documentation
 
-- [Complete User Guide](docs/plinth-complete-guide.md)
-- [Developer Guide](docs/developer-guide.md)
+- [Complete User Guide](https://github.com/CyberTycoon/plinth/blob/main/docs/plinth-complete-guide.md)
+- [Developer Guide](https://github.com/CyberTycoon/plinth/blob/main/docs/developer-guide.md)
+- [Roadmap](https://github.com/CyberTycoon/plinth/blob/main/ROADMAP.md)
 
 ## License
 

plinth_cli-1.0.3/ROADMAP.md

@@ -0,0 +1,128 @@
+# 🗺️ Plinth-CLI Roadmap
+
+> This roadmap outlines our vision for Plinth-CLI through 2027 and beyond. We are committed to long-term maintenance and continuous improvement.
+
+**Legend:**
+
+- ✅ **Implemented** — Available now
+- 🚧 **In Progress** — Actively being developed
+- 📋 **Planned** — Committed for this quarter
+- 💡 **Proposed** — Under consideration, may change based on community feedback
+
+---
+
+## Current Status
+
+Plinth-CLI is actively maintained and production-ready at v1.0.2. We follow semantic versioning and maintain backward compatibility within major versions.
+
+### ✅ Implemented Features
+
+- **Core Commands:** `init`, `add`, `list`, `remove`, `doctor`
+- **Database Modules:** PostgreSQL, MySQL, SQLite with SQLAlchemy 2.0
+- **Authentication:** JWT and session-based auth
+- **Caching:** Redis integration
+- **Code Injection:** AST-aware modifications via LibCST
+- **State Management:** `.plinth.json` for tracking project configuration
+
+---
+
+## 2026 Milestones
+
+### Q1 2026: Stability & Core Extensions
+
+**Focus:** Hardening existing features and expanding the module catalog
+
+- [ ] 📋 **Testing Module** — `plinth add pytest` for test scaffolding with fixtures
+- [ ] 📋 **Docker Module** — Enhanced Docker Compose with PostgreSQL/Redis services
+- [ ] 📋 **Linting Module** — `plinth add ruff` for code formatting and linting
+- [ ] 📋 **MongoDB Module** — NoSQL database support via Motor
+- [ ] 📋 **Doctor Enhancements** — Better diagnostics for missing dependencies
+
+### Q2 2026: Developer Experience
+
+**Focus:** Making Plinth-CLI more powerful for existing FastAPI projects
+
+- [ ] 📋 **Project Templates** — `plinth init --template microservice` for different architectures
+- [ ] 📋 **Alembic Integration** — `plinth add migrations` with auto-generated revision support
+- [ ] 📋 **Celery Module** — Background task queues with Redis/RabbitMQ
+- [ ] 📋 **Environment Sync** — `plinth sync` to reconcile .env with pyproject.toml
+- [ ] 📋 **Upgrade Command** — `plinth upgrade` to update modules to latest versions
+
+### Q3 2026: Ecosystem Growth
+
+**Focus:** Community modules and integrations
+
+- [ ] 💡 **Module Registry** — Public index for community-contributed modules
+- [ ] 💡 **Webhook Module** — Stripe, GitHub webhook handlers
+- [ ] 💡 **Email Module** — FastMail, SendGrid integration templates
+- [ ] 💡 **GraphQL Module** — Strawberry GraphQL scaffolding
+- [ ] 💡 **OpenAPI Enhancements** — Better documentation generation
+
+### Q4 2026: Enterprise & Scale
+
+**Focus:** Supporting larger teams and deployments
+
+- [ ] 💡 **Configuration Profiles** — Save and share project templates
+- [ ] 💡 **CI/CD Templates** — GitHub Actions, GitLab CI scaffolding
+- [ ] 💡 **Monitoring Module** — Prometheus metrics endpoints
+- [ ] 💡 **Structured Logging** — JSON logging with correlation IDs
+- [ ] 💡 **Health Checks** — Advanced health check endpoints with dependency status
+
+---
+
+## 2027 Milestones
+
+### Q1 2027: Platform Foundations
+
+**Focus:** Building infrastructure for broader adoption
+
+- [ ] 💡 **Plugin System** — Third-party module loading
+- [ ] 💡 **Private Registries** — Self-hosted module hosting
+- [ ] 💡 **Team Features** — Shared templates within organizations
+- [ ] 💡 **VS Code Extension** — IDE integration for module management
+
+### Q2 2027+ : Long-Term Vision
+
+**Focus:** Expanding beyond core functionality
+
+- [ ] 💡 **Framework Expansion** — Experimental Django/Flask scaffolding
+- [ ] 💡 **Cloud Integrations** — AWS CDK, Azure Bicep templates
+- [ ] 💡 **Kubernetes Support** — Helm chart generation
+- [ ] 💡 **AI-Assisted Scaffolding** — Intelligent module recommendations
+
+---
+
+## How to Contribute
+
+We welcome contributions! To propose a new module or feature:
+
+1. Open a [GitHub Discussion](https://github.com/cybertycoon/plinth/discussions)
+2. Submit a [GitHub Issue](https://github.com/cybertycoon/plinth/issues)
+
+### Contributing New Modules
+
+Modules are Jinja2 templates in `src/plinth/templates/`. See existing modules for patterns:
+
+- [`src/plinth/templates/base/`](src/plinth/templates/base/) — Base project template
+- Add module metadata to [`plinth_config.AVAILABLE_MODULES`](src/plinth/config.py:72)
+
+---
+
+## Version Support Policy
+
+| Version | Status             | Support Until      |
+| ------- | ------------------ | ------------------ |
+| 1.x     | Active Development | Q4 2027            |
+| 0.x     | End of Life        | Already deprecated |
+
+---
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md) for detailed release notes.
+
+---
+
+_Last updated: March 2026_
+
+_This roadmap is a living document. Priorities may shift based on community feedback and maintainer capacity. Features marked with 💡 are aspirational and subject to change._