tempest-fastapi-sdk 0.47.0__tar.gz → 0.48.0__tar.gz

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to **tempest-fastapi-sdk** are listed below.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.48.0] — 2026-06-11
+
+### Changed
+
+- **Scaffolded services read their API `title` / `version` /
+  `description` from `.env`.** `tempest new` previously hardcoded
+  `FastAPI(title="<project>", version="0.1.0")` and the health-router
+  version in `src/api/app.py`. The scaffolded `Settings` now carries
+  `TITLE`, `DESCRIPTION` and `VERSION` fields (each with `title` /
+  `description` / `examples`), `app.py` reads them
+  (`FastAPI(title=settings.TITLE, version=settings.VERSION, ...)`,
+  `make_health_router(version=settings.VERSION)`,
+  `AdminSite(title=f"{settings.TITLE} admin")`), and `.env.example`
+  ships a documented `TITLE` / `VERSION` / `DESCRIPTION` block — so the
+  OpenAPI docs and admin header are configurable without editing code.
+
 ## [0.47.0] — 2026-06-11
 
 ### Added

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tempest-fastapi-sdk
-Version: 0.47.0
+Version: 0.48.0
 Summary: Shared FastAPI building blocks: base schemas, ORM model, async repository, exceptions, pagination and settings — the conventions used across Tempest projects.
 Project-URL: Homepage, https://github.com/mauriciobenjamin700/tempest-fastapi-sdk
 Project-URL: Repository, https://github.com/mauriciobenjamin700/tempest-fastapi-sdk
@@ -3345,7 +3345,7 @@ The skeleton matches the layered architecture documented in this README:
 my_service/
 ├── main.py                  # one-liner → src.server.run()
 ├── pyproject.toml           # pins tempest-fastapi-sdk + ruff/mypy/pytest
-├── .env.example             # HOST/PORT/DATABASE_URL/JWT_SECRET/CORS_ORIGINS
+├── .env.example             # TITLE/VERSION/HOST/PORT/DATABASE_URL/JWT_SECRET/CORS_ORIGINS
 ├── .gitignore
 ├── README.md
 ├── src/
@@ -3366,7 +3366,7 @@ my_service/
     └── test_smoke.py        # asserts /api/ and /health/liveness boot
 ```
 
-The generated `pyproject.toml` pins the current SDK version (`tempest-fastapi-sdk[auth]>=<version>` by default — change with `--extras`). The scaffolded `.env.example` uses the v0.8.0 settings naming (`SERVER_HOST`/`SERVER_PORT`/`SERVER_DEBUG`/`SERVER_RELOAD`/`LOG_LEVEL`/…), and `src/server.py` delegates to `tempest_fastapi_sdk.run_server` so uvicorn is imported lazily and tests can import the app without it. Validation rules: the project name must match `^[a-z][a-z0-9_]*$` and cannot collide with a Python keyword, so `tempest new Bad-Name` and `tempest new class` exit with code 2 before any file is written.
+The generated `pyproject.toml` pins the current SDK version (`tempest-fastapi-sdk[auth]>=<version>` by default — change with `--extras`). The scaffolded `.env.example` uses the v0.8.0 settings naming (`SERVER_HOST`/`SERVER_PORT`/`SERVER_DEBUG`/`SERVER_RELOAD`/`LOG_LEVEL`/…), and `src/server.py` delegates to `tempest_fastapi_sdk.run_server` so uvicorn is imported lazily and tests can import the app without it. The API `title`, `version` and `description` shown in the OpenAPI docs (and the `/admin` header) come from the `TITLE` / `VERSION` / `DESCRIPTION` settings — set them in `.env`, no code edits. Validation rules: the project name must match `^[a-z][a-z0-9_]*$` and cannot collide with a Python keyword, so `tempest new Bad-Name` and `tempest new class` exit with code 2 before any file is written.
 
 After scaffolding:
 

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/README.md

@@ -3243,7 +3243,7 @@ The skeleton matches the layered architecture documented in this README:
 my_service/
 ├── main.py                  # one-liner → src.server.run()
 ├── pyproject.toml           # pins tempest-fastapi-sdk + ruff/mypy/pytest
-├── .env.example             # HOST/PORT/DATABASE_URL/JWT_SECRET/CORS_ORIGINS
+├── .env.example             # TITLE/VERSION/HOST/PORT/DATABASE_URL/JWT_SECRET/CORS_ORIGINS
 ├── .gitignore
 ├── README.md
 ├── src/
@@ -3264,7 +3264,7 @@ my_service/
     └── test_smoke.py        # asserts /api/ and /health/liveness boot
 ```
 
-The generated `pyproject.toml` pins the current SDK version (`tempest-fastapi-sdk[auth]>=<version>` by default — change with `--extras`). The scaffolded `.env.example` uses the v0.8.0 settings naming (`SERVER_HOST`/`SERVER_PORT`/`SERVER_DEBUG`/`SERVER_RELOAD`/`LOG_LEVEL`/…), and `src/server.py` delegates to `tempest_fastapi_sdk.run_server` so uvicorn is imported lazily and tests can import the app without it. Validation rules: the project name must match `^[a-z][a-z0-9_]*$` and cannot collide with a Python keyword, so `tempest new Bad-Name` and `tempest new class` exit with code 2 before any file is written.
+The generated `pyproject.toml` pins the current SDK version (`tempest-fastapi-sdk[auth]>=<version>` by default — change with `--extras`). The scaffolded `.env.example` uses the v0.8.0 settings naming (`SERVER_HOST`/`SERVER_PORT`/`SERVER_DEBUG`/`SERVER_RELOAD`/`LOG_LEVEL`/…), and `src/server.py` delegates to `tempest_fastapi_sdk.run_server` so uvicorn is imported lazily and tests can import the app without it. The API `title`, `version` and `description` shown in the OpenAPI docs (and the `/admin` header) come from the `TITLE` / `VERSION` / `DESCRIPTION` settings — set them in `.env`, no code edits. Validation rules: the project name must match `^[a-z][a-z0-9_]*$` and cannot collide with a Python keyword, so `tempest new Bad-Name` and `tempest new class` exit with code 2 before any file is written.
 
 After scaffolding:
 

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/docs/recipes/cli.en.md

@@ -39,7 +39,7 @@ The skeleton matches the layered architecture documented in this README:
 my_service/
 ├── main.py                  # one-liner → src.server.run()
 ├── pyproject.toml           # pins tempest-fastapi-sdk + ruff/mypy/pytest
-├── .env.example             # HOST/PORT/DATABASE_URL/JWT_SECRET/CORS_ORIGINS
+├── .env.example             # TITLE/VERSION/HOST/PORT/DATABASE_URL/JWT_SECRET/CORS_ORIGINS
 ├── docker-compose.yaml      # services keyed to the chosen extras
 ├── .gitignore
 ├── README.md
@@ -63,6 +63,21 @@ my_service/
 
 The generated `pyproject.toml` pins the current SDK version (`tempest-fastapi-sdk[auth,admin]>=<version>` by default — change with `--extras`). The scaffolded `.env.example` uses the v0.8.0 settings naming (`SERVER_HOST`/`SERVER_PORT`/`SERVER_DEBUG`/`SERVER_RELOAD`/`LOG_LEVEL`/…), and `src/server.py` delegates to `tempest_fastapi_sdk.run_server` so uvicorn is imported lazily and tests can import the app without it. Validation rules: the project name must match `^[a-z][a-z0-9_]*$` and cannot collide with a Python keyword, so `tempest new Bad-Name` and `tempest new class` exit with code 2 before any file is written.
 
+!!! tip "API title / version come from `.env`"
+    Since v0.48.0 the scaffolded `Settings` carries `TITLE`, `VERSION`
+    and `DESCRIPTION`, and `src/api/app.py` consumes them
+    (`FastAPI(title=settings.TITLE, version=settings.VERSION,
+    description=settings.DESCRIPTION)`, `make_health_router(version=
+    settings.VERSION)` and `AdminSite(title=f"{settings.TITLE} admin")`).
+    Tune the title shown in Swagger/ReDoc and the `/admin` header from
+    `.env`, no code edits:
+
+    ```bash
+    TITLE=My API
+    VERSION=1.2.0
+    DESCRIPTION=Payments API for product X.
+    ```
+
 ### Extras-driven `docker-compose.yaml`
 
 Since v0.25.0 the scaffold generates a `docker-compose.yaml` carrying **only** the supporting services the chosen extras actually need — no ZooKeeper, no Kafka, nothing you won't use.

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/docs/recipes/cli.md

@@ -39,7 +39,7 @@ O esqueleto casa com a arquitetura em camadas documentada neste README:
 my_service/
 ├── main.py                  # one-liner → src.server.run()
 ├── pyproject.toml           # fixa tempest-fastapi-sdk + ruff/mypy/pytest
-├── .env.example             # HOST/PORT/DATABASE_URL/JWT_SECRET/CORS_ORIGINS
+├── .env.example             # TITLE/VERSION/HOST/PORT/DATABASE_URL/JWT_SECRET/CORS_ORIGINS
 ├── docker-compose.yaml      # serviços baseados nos extras escolhidos
 ├── .gitignore
 ├── README.md
@@ -63,6 +63,21 @@ my_service/
 
 O `pyproject.toml` gerado fixa a versão atual do SDK (`tempest-fastapi-sdk[auth,admin]>=<versão>` por padrão — mude com `--extras`). O `.env.example` criado usa a nomenclatura de settings da v0.8.0 (`SERVER_HOST`/`SERVER_PORT`/`SERVER_DEBUG`/`SERVER_RELOAD`/`LOG_LEVEL`/…), e `src/server.py` delega a `tempest_fastapi_sdk.run_server` para que o uvicorn seja importado de forma preguiçosa e os testes possam importar o app sem ele. Regras de validação: o nome do projeto deve casar com `^[a-z][a-z0-9_]*$` e não pode colidir com uma palavra-chave do Python, então `tempest new Bad-Name` e `tempest new class` saem com código 2 antes de qualquer arquivo ser escrito.
 
+!!! tip "Título / versão da API vêm do `.env`"
+    A partir da v0.48.0 o `Settings` scaffoldado carrega `TITLE`,
+    `VERSION` e `DESCRIPTION`, e `src/api/app.py` os consome
+    (`FastAPI(title=settings.TITLE, version=settings.VERSION,
+    description=settings.DESCRIPTION)`, `make_health_router(version=
+    settings.VERSION)` e `AdminSite(title=f"{settings.TITLE} admin")`).
+    Ajuste o título mostrado no Swagger/ReDoc e no header do `/admin`
+    direto no `.env`, sem editar código:
+
+    ```bash
+    TITLE=Minha API
+    VERSION=1.2.0
+    DESCRIPTION=API de pagamentos do produto X.
+    ```
+
 ### `docker-compose.yaml` baseado nos extras
 
 Desde a v0.25.0 o scaffold gera um `docker-compose.yaml` com **apenas** os serviços que os extras escolhidos precisam — sem ZooKeeper, Kafka ou qualquer outra coisa que você não vai usar.

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tempest-fastapi-sdk"
-version = "0.47.0"
+version = "0.48.0"
 description = "Shared FastAPI building blocks: base schemas, ORM model, async repository, exceptions, pagination and settings — the conventions used across Tempest projects."
 readme = "README.md"
 requires-python = ">=3.11"

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/tempest_fastapi_sdk/__init__.py

@@ -250,7 +250,7 @@ from tempest_fastapi_sdk.websockets import (
     make_websocket_router,
 )
 
-__version__: str = "0.47.0"
+__version__: str = "0.48.0"
 
 __all__: list[str] = [
     "BASE_COLUMN_ORDER",

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/tempest_fastapi_sdk/cli/_templates/env.example.tmpl

@@ -1,3 +1,8 @@
+# API metadata (shown in the OpenAPI docs + admin panel header)
+TITLE=__PROJECT_NAME__
+VERSION=0.1.0
+# DESCRIPTION=Backend API for __PROJECT_NAME__.
+
 # Server
 SERVER_HOST=__HOST__
 SERVER_PORT=__PORT__

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/tempest_fastapi_sdk/cli/_templates/src/api/app.py.tmpl

@@ -48,8 +48,9 @@ def create_app() -> FastAPI:
         FastAPI: A fully wired application ready for uvicorn.
     """
     app = FastAPI(
-        title="__PROJECT_NAME__",
-        version="0.1.0",
+        title=settings.TITLE,
+        description=settings.DESCRIPTION,
+        version=settings.VERSION,
         lifespan=lifespan,
     )
 
@@ -58,7 +59,7 @@ def create_app() -> FastAPI:
     register_exception_handlers(app)
 
     app.include_router(
-        make_health_router(db=db, version="0.1.0"),
+        make_health_router(db=db, version=settings.VERSION),
     )
     app.include_router(
         make_logs_router(
@@ -72,7 +73,7 @@ def create_app() -> FastAPI:
     # Alembic migration:
     #   uv run alembic upgrade head
     #   uv run python -c "..."  # set hashed_password + is_admin=True
-    admin_site = AdminSite(title="__PROJECT_NAME__ admin")
+    admin_site = AdminSite(title=f"{settings.TITLE} admin")
     admin_site.register(AdminModel(model=UserModel))
     app.include_router(
         make_admin_router(

tempest_fastapi_sdk-0.48.0/tempest_fastapi_sdk/cli/_templates/src/core/settings.py.tmpl

@@ -0,0 +1,61 @@
+"""Application settings — composed from SDK mixins + service overrides."""
+
+from __future__ import annotations
+
+from pydantic import Field
+
+from tempest_fastapi_sdk import (
+    BaseAppSettings,
+    CORSSettings,
+    DatabaseSettings,
+    JWTSettings,
+    LogSettings,
+    ServerSettings,
+    TokenSettings,
+)
+
+
+class Settings(
+    ServerSettings,
+    LogSettings,
+    DatabaseSettings,
+    JWTSettings,
+    TokenSettings,
+    CORSSettings,
+    BaseAppSettings,
+):
+    """Service-wide settings backed by the ``.env`` file.
+
+    Attributes:
+        TITLE (str): API title shown in the OpenAPI docs and the admin
+            panel header. Override via the ``TITLE`` env var.
+        DESCRIPTION (str): Optional API description shown in the OpenAPI
+            docs. Override via the ``DESCRIPTION`` env var.
+        VERSION (str): Version surfaced in the OpenAPI docs and on the
+            health router. Override via the ``VERSION`` env var.
+    """
+
+    TITLE: str = Field(
+        default="__PROJECT_NAME__",
+        title="API title",
+        description="Shown in the OpenAPI docs and the admin panel header.",
+        examples=["__PROJECT_NAME__"],
+    )
+    DESCRIPTION: str = Field(
+        default="",
+        title="API description",
+        description="Optional summary shown in the OpenAPI docs.",
+        examples=["Backend API for __PROJECT_NAME__."],
+    )
+    VERSION: str = Field(
+        default="0.1.0",
+        title="API version",
+        description="Surfaced in the OpenAPI docs and the health router.",
+        examples=["0.1.0"],
+    )
+
+
+settings = Settings()
+
+
+__all__: list[str] = ["Settings", "settings"]

{tempest_fastapi_sdk-0.47.0 → tempest_fastapi_sdk-0.48.0}/uv.lock

@@ -2792,7 +2792,7 @@ wheels = [
 
 [[package]]
 name = "tempest-fastapi-sdk"
-version = "0.47.0"
+version = "0.48.0"
 source = { editable = "." }
 dependencies = [
     { name = "alembic" },

tempest_fastapi_sdk-0.47.0/tempest_fastapi_sdk/cli/_templates/src/core/settings.py.tmpl

@@ -1,39 +0,0 @@
-"""Application settings — composed from SDK mixins + service overrides."""
-
-from __future__ import annotations
-
-from pydantic import Field
-
-from tempest_fastapi_sdk import (
-    BaseAppSettings,
-    CORSSettings,
-    DatabaseSettings,
-    JWTSettings,
-    LogSettings,
-    ServerSettings,
-    TokenSettings,
-)
-
-
-class Settings(
-    ServerSettings,
-    LogSettings,
-    DatabaseSettings,
-    JWTSettings,
-    TokenSettings,
-    CORSSettings,
-    BaseAppSettings,
-):
-    """Service-wide settings backed by the ``.env`` file.
-
-    Attributes:
-        VERSION (str): Version surfaced on the health router.
-    """
-
-    VERSION: str = Field(default="0.1.0")
-
-
-settings = Settings()
-
-
-__all__: list[str] = ["Settings", "settings"]