pyvel-fastapi 0.1.0__tar.gz

pyvel_fastapi-0.1.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.3
+Name: pyvel-fastapi
+Version: 0.1.0
+Summary: Laravel-shaped DX for Python API backends on FastAPI — Artisan-like CLI and runtime bases
+Keywords: fastapi,laravel,artisan,cli,scaffold,backend,api,pyvel
+Author: Al-Amin Islam Nerob
+Author-email: Al-Amin Islam Nerob <alamin@aincoder.com>
+License: MIT
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: typer>=0.12.0
+Requires-Dist: uvicorn>=0.30.0
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/aincoder/pyvel
+Project-URL: Repository, https://github.com/aincoder/pyvel
+Project-URL: Documentation, https://github.com/aincoder/pyvel#readme
+Description-Content-Type: text/markdown
+
+# pyvel
+
+Batteries-included **Laravel-shaped** DX for **Python API backends** on FastAPI.
+
+Pyvel gives you an Artisan-like CLI (`pyvel` / `artisan`), convention-based project layout, and small runtime bases (`AppError`, `register`, events). It is **backend/API only** — no Blade, Vite, or frontend stack.
+
+> Long-term plans: see the workspace [`roadmap/`](../../roadmap/).
+
+---
+
+## Install
+
+```bash
+uv add pyvel-fastapi
+# or
+pip install pyvel-fastapi
+```
+
+The import and CLI stay **`pyvel`**:
+
+```python
+from pyvel import AppError, register
+```
+
+---
+
+## Quick start
+
+```bash
+uvx --from pyvel-fastapi pyvel init myapp
+cd myapp
+uv sync
+uv run dev
+```
+
+Scaffold into the current directory:
+
+```bash
+mkdir myapp && cd myapp
+uvx --from pyvel-fastapi pyvel init
+```
+
+Monorepo / unpublished local checkout:
+
+```bash
+uv run pyvel init myapp --pyvel-path /path/to/packages/pyvel
+```
+
+---
+
+## Stable CLI (0.1)
+
+Entry points: `pyvel`, `artisan` (alias), and `dev`.
+
+| Command | Purpose |
+| --- | --- |
+| `pyvel init [name]` | Scaffold a new API app (`--force`, `--pyvel-path`) |
+| `pyvel make:exc` | Exception + HTTP handler |
+| `pyvel make:req` / `make:res` | Request / response models |
+| `pyvel make:middleware` | Middleware class |
+| `pyvel make:router` | APIRouter module |
+| `pyvel make:service` | Service class |
+| `pyvel make:dependency` | FastAPI dependency |
+| `pyvel make:schema` / `make:enum` / `make:config` | Schema, enum, settings |
+| `pyvel make:event` / `make:listener` / `make:job` | Events, listeners, jobs |
+| `pyvel make:test` | Pytest stub |
+| `pyvel make:resource` | Router + requests + response + service |
+| `pyvel list:routes` | List registered FastAPI routes |
+| `dev` | Run uvicorn using `pyvel.toml` `[dev]` |
+
+---
+
+## Stable public API (0.1)
+
+Supported imports for application code:
+
+```python
+from pyvel import AppError, EventDispatcher, dispatcher, register
+
+# optional
+import pyvel
+print(pyvel.__version__)
+```
+
+| Symbol | Role |
+| --- | --- |
+| `AppError` | Base application error (override via `[bases].error`) |
+| `register(app)` | Auto-register handlers, middleware, routers, listeners |
+| `dispatcher` / `EventDispatcher` | In-process events |
+
+Everything else under `pyvel.*` (`templates`, `generate`, `make`, `config` internals, …) is **private** and may change without notice.
+
+See also [`API.md`](API.md).
+
+---
+
+## Config (`pyvel.toml`, optional)
+
+All keys optional. Defaults:
+
+```toml
+app = "myapp"       # required in practice — set by `init`
+src = "src"
+
+[dev]
+module = "myapp.main:app"   # default: "{app}.main:app"
+host = "0.0.0.0"
+port = 8000
+reload = true
+
+[paths]
+errors = "http/exception/errors"
+handlers = "http/exception/handlers"
+requests = "http/requests"
+responses = "http/responses"
+middleware = "http/middleware"
+routers = "http/routers"
+dependencies = "http/dependencies"
+services = "services"
+schemas = "schemas"
+enums = "domain/enums"
+config = "config"
+events = "events"
+listeners = "listeners"
+jobs = "jobs"
+tests = "tests"             # relative to project root
+
+[bases]
+error = "pyvel.errors:AppError"
+```
+
+Fallback: `[tool.pyvel] app = "..."` in `pyproject.toml`.
+
+---
+
+## Out of scope (for now)
+
+- Laravel-like `routes.py` + `Route` DSL / controllers — **Phase 1**
+- Database / migrations — **Phase 2** (`pyvel-db`)
+- Auth / policies — **Phase 3** (`pyvel-auth`)
+- Queues, cache, mail — **Phase 4+**
+- Frontend scaffolding — never (API-only)
+
+---
+
+## Publish (maintainers)
+
+From the package directory, build into a local `dist/` then publish (workspace root builds go to the repo `dist/` by default):
+
+```bash
+cd packages/pyvel
+uv build --out-dir dist
+uv publish
+# Uploads as distribution name: pyvel-fastapi
+# or TestPyPI:
+# uv publish --publish-url https://test.pypi.org/legacy/
+```
+
+From the workspace root (if artifacts are already in `./dist`):
+
+```bash
+uv publish dist/pyvel_fastapi-* dist/pyvel-fastapi-*
+```
+
+Until published, verify locally from a wheel:
+
+```bash
+uvx --from ./dist/pyvel_fastapi-0.1.0-py3-none-any.whl pyvel init /tmp/demoapp
+# (wheel filename uses underscores; project name uses hyphens)
+```
+
+---
+
+## Roadmap
+
+Workspace plans: [`roadmap/README.md`](../../roadmap/README.md). **Phase 0 complete**; next is **Phase 1** (Artisan routing).

pyvel_fastapi-0.1.0/README.md

@@ -0,0 +1,176 @@
+# pyvel
+
+Batteries-included **Laravel-shaped** DX for **Python API backends** on FastAPI.
+
+Pyvel gives you an Artisan-like CLI (`pyvel` / `artisan`), convention-based project layout, and small runtime bases (`AppError`, `register`, events). It is **backend/API only** — no Blade, Vite, or frontend stack.
+
+> Long-term plans: see the workspace [`roadmap/`](../../roadmap/).
+
+---
+
+## Install
+
+```bash
+uv add pyvel-fastapi
+# or
+pip install pyvel-fastapi
+```
+
+The import and CLI stay **`pyvel`**:
+
+```python
+from pyvel import AppError, register
+```
+
+---
+
+## Quick start
+
+```bash
+uvx --from pyvel-fastapi pyvel init myapp
+cd myapp
+uv sync
+uv run dev
+```
+
+Scaffold into the current directory:
+
+```bash
+mkdir myapp && cd myapp
+uvx --from pyvel-fastapi pyvel init
+```
+
+Monorepo / unpublished local checkout:
+
+```bash
+uv run pyvel init myapp --pyvel-path /path/to/packages/pyvel
+```
+
+---
+
+## Stable CLI (0.1)
+
+Entry points: `pyvel`, `artisan` (alias), and `dev`.
+
+| Command | Purpose |
+| --- | --- |
+| `pyvel init [name]` | Scaffold a new API app (`--force`, `--pyvel-path`) |
+| `pyvel make:exc` | Exception + HTTP handler |
+| `pyvel make:req` / `make:res` | Request / response models |
+| `pyvel make:middleware` | Middleware class |
+| `pyvel make:router` | APIRouter module |
+| `pyvel make:service` | Service class |
+| `pyvel make:dependency` | FastAPI dependency |
+| `pyvel make:schema` / `make:enum` / `make:config` | Schema, enum, settings |
+| `pyvel make:event` / `make:listener` / `make:job` | Events, listeners, jobs |
+| `pyvel make:test` | Pytest stub |
+| `pyvel make:resource` | Router + requests + response + service |
+| `pyvel list:routes` | List registered FastAPI routes |
+| `dev` | Run uvicorn using `pyvel.toml` `[dev]` |
+
+---
+
+## Stable public API (0.1)
+
+Supported imports for application code:
+
+```python
+from pyvel import AppError, EventDispatcher, dispatcher, register
+
+# optional
+import pyvel
+print(pyvel.__version__)
+```
+
+| Symbol | Role |
+| --- | --- |
+| `AppError` | Base application error (override via `[bases].error`) |
+| `register(app)` | Auto-register handlers, middleware, routers, listeners |
+| `dispatcher` / `EventDispatcher` | In-process events |
+
+Everything else under `pyvel.*` (`templates`, `generate`, `make`, `config` internals, …) is **private** and may change without notice.
+
+See also [`API.md`](API.md).
+
+---
+
+## Config (`pyvel.toml`, optional)
+
+All keys optional. Defaults:
+
+```toml
+app = "myapp"       # required in practice — set by `init`
+src = "src"
+
+[dev]
+module = "myapp.main:app"   # default: "{app}.main:app"
+host = "0.0.0.0"
+port = 8000
+reload = true
+
+[paths]
+errors = "http/exception/errors"
+handlers = "http/exception/handlers"
+requests = "http/requests"
+responses = "http/responses"
+middleware = "http/middleware"
+routers = "http/routers"
+dependencies = "http/dependencies"
+services = "services"
+schemas = "schemas"
+enums = "domain/enums"
+config = "config"
+events = "events"
+listeners = "listeners"
+jobs = "jobs"
+tests = "tests"             # relative to project root
+
+[bases]
+error = "pyvel.errors:AppError"
+```
+
+Fallback: `[tool.pyvel] app = "..."` in `pyproject.toml`.
+
+---
+
+## Out of scope (for now)
+
+- Laravel-like `routes.py` + `Route` DSL / controllers — **Phase 1**
+- Database / migrations — **Phase 2** (`pyvel-db`)
+- Auth / policies — **Phase 3** (`pyvel-auth`)
+- Queues, cache, mail — **Phase 4+**
+- Frontend scaffolding — never (API-only)
+
+---
+
+## Publish (maintainers)
+
+From the package directory, build into a local `dist/` then publish (workspace root builds go to the repo `dist/` by default):
+
+```bash
+cd packages/pyvel
+uv build --out-dir dist
+uv publish
+# Uploads as distribution name: pyvel-fastapi
+# or TestPyPI:
+# uv publish --publish-url https://test.pypi.org/legacy/
+```
+
+From the workspace root (if artifacts are already in `./dist`):
+
+```bash
+uv publish dist/pyvel_fastapi-* dist/pyvel-fastapi-*
+```
+
+Until published, verify locally from a wheel:
+
+```bash
+uvx --from ./dist/pyvel_fastapi-0.1.0-py3-none-any.whl pyvel init /tmp/demoapp
+# (wheel filename uses underscores; project name uses hyphens)
+```
+
+---
+
+## Roadmap
+
+Workspace plans: [`roadmap/README.md`](../../roadmap/README.md). **Phase 0 complete**; next is **Phase 1** (Artisan routing).

pyvel_fastapi-0.1.0/pyproject.toml

@@ -0,0 +1,61 @@
+[project]
+name = "pyvel-fastapi"
+version = "0.1.0"
+description = "Laravel-shaped DX for Python API backends on FastAPI — Artisan-like CLI and runtime bases"
+readme = "README.md"
+requires-python = ">=3.11"
+keywords = [
+    "fastapi",
+    "laravel",
+    "artisan",
+    "cli",
+    "scaffold",
+    "backend",
+    "api",
+    "pyvel",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Typing :: Typed",
+]
+dependencies = [
+    "fastapi>=0.115.0",
+    "pydantic>=2.0",
+    "pydantic-settings>=2.0",
+    "typer>=0.12.0",
+    "uvicorn>=0.30.0",
+]
+
+[project.license]
+text = "MIT"
+
+[[project.authors]]
+name = "Al-Amin Islam Nerob"
+email = "alamin@aincoder.com"
+
+[project.urls]
+Homepage = "https://github.com/aincoder/pyvel"
+Repository = "https://github.com/aincoder/pyvel"
+Documentation = "https://github.com/aincoder/pyvel#readme"
+
+[project.scripts]
+pyvel = "pyvel.app:app"
+artisan = "pyvel.app:app"
+dev = "pyvel.app:dev"
+
+[build-system]
+requires = ["uv_build>=0.12.18,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "pyvel"

pyvel_fastapi-0.1.0/pyproject.toml.orig

@@ -0,0 +1,58 @@
+[project]
+name = "pyvel-fastapi"
+version = "0.1.0"
+description = "Laravel-shaped DX for Python API backends on FastAPI — Artisan-like CLI and runtime bases"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [
+    { name = "Al-Amin Islam Nerob", email = "alamin@aincoder.com" }
+]
+keywords = [
+    "fastapi",
+    "laravel",
+    "artisan",
+    "cli",
+    "scaffold",
+    "backend",
+    "api",
+    "pyvel",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Framework :: FastAPI",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Typing :: Typed",
+]
+dependencies = [
+    "fastapi>=0.115.0",
+    "pydantic>=2.0",
+    "pydantic-settings>=2.0",
+    "typer>=0.12.0",
+    "uvicorn>=0.30.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/aincoder/pyvel"
+Repository = "https://github.com/aincoder/pyvel"
+Documentation = "https://github.com/aincoder/pyvel#readme"
+
+[project.scripts]
+pyvel = "pyvel.app:app"
+artisan = "pyvel.app:app"
+dev = "pyvel.app:dev"
+
+[build-system]
+requires = ["uv_build>=0.12.18,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "pyvel"

pyvel_fastapi-0.1.0/src/pyvel/__init__.py

@@ -0,0 +1,8 @@
+"""pyvel — FastAPI scaffolding CLI and shared runtime bases."""
+
+from pyvel.errors import AppError
+from pyvel.events import EventDispatcher, dispatcher
+from pyvel.registry import register
+
+__all__ = ["AppError", "EventDispatcher", "dispatcher", "register"]
+__version__ = "0.1.0"

pyvel_fastapi-0.1.0/src/pyvel/app.py

@@ -0,0 +1,46 @@
+"""pyvel CLI entrypoints (`pyvel`, `artisan`, and `dev`)."""
+
+from __future__ import annotations
+
+import sys
+
+import typer
+import uvicorn
+
+from pyvel import init_cmd, list_cmd, make
+from pyvel.config import clear_settings_cache, load_settings
+
+app = typer.Typer(
+    name="pyvel",
+    help="Laravel-shaped scaffolding CLI for Python API backends on FastAPI.",
+    no_args_is_help=True,
+    add_completion=False,
+)
+
+init_cmd.register(app)
+make.register(app)
+list_cmd.register(app)
+
+
+def _clear_terminal() -> None:
+    """Clear the screen and scrollback buffer."""
+    sys.stdout.write("\033[2J\033[3J\033[H")
+    sys.stdout.flush()
+
+
+def dev() -> None:
+    """Run the API with settings from optional `pyvel.toml`."""
+    clear_settings_cache()
+    settings = load_settings()
+    dev_cfg = settings.resolved_dev()
+    _clear_terminal()
+    uvicorn.run(
+        dev_cfg.module,
+        host=dev_cfg.host,
+        port=dev_cfg.port,
+        reload=dev_cfg.reload,
+    )
+
+
+if __name__ == "__main__":
+    app()