csrd-models
Shared Pydantic models, settings, and parsing utilities for FastAPI microservices.
Package: csrd.models · Import: from csrd.models import BaseModel, BaseSettings
What's included
BaseModel/BaseSettingswith camelCase alias config andpopulate_by_name=TrueModelParserMixin— response parsing mixin for delegates and repositoriesPayloadExtractor/DefaultExtractor— pluggable payload extractionUserClaims— JWT user claims dataclassAPIErrorResponse,ErrorMeta,Error,APIVersion— structured error response modelsSecret/InternalToken— settings field marker that refuses to boot on empty, short or placeholder secretsapp_env/is_productiononBaseSettings,ProductionRequired,Secret(production_only=True)— production-boot checks
Secret settings
from typing import Annotated
from csrd.models import BaseSettings, InternalToken, Secret
class Settings(BaseSettings):
internal_token: InternalToken = "" # Annotated[str, Secret()] — min 32 chars
db_password: Annotated[str, Secret(min_length=16, placeholders=("dev-password",))] = "change_me"
Secret(min_length=32, placeholders=(), markers=DEFAULT_PLACEHOLDER_MARKERS)
rejects empty/whitespace values, values containing a marker (change_me,
changeme, change-me, <generate; case-insensitive), any declared
placeholder, and values shorter than min_length. It works on str and
SecretStr; None passes through for str | None fields. Validation runs when
settings load (pydantic-settings validates defaults), and a single
ValidationError lists every offending field. BaseSettings sets
hide_input_in_errors=True, so rejected values never appear in the error.
Production checks
from typing import Annotated
from csrd.models import BaseSettings, InternalToken, ProductionRequired, Secret
class Settings(BaseSettings):
# app_env: str = "development" — inherited; env var APP_ENV, lower-cased
internal_token: InternalToken = "" # always checked
db_password: Annotated[str, Secret(production_only=True)] = "change_me" # checked in production
cookie_secure: Annotated[bool, ProductionRequired(True)] = False # must be True in production
public_base_url: Annotated[str, ProductionRequired()] = "" # must be set in production
BaseSettings.app_env(envAPP_ENV, default"development"; any name, stripped and lower-cased) andsettings.is_production(app_env == "production").ProductionRequired(value): withAPP_ENV=productionthe field must equalvalue;ProductionRequired()only requires it to be set (notNone, empty string or empty collection). Error typeproduction_required.Secret(production_only=True): the usual secret checks, but only whenAPP_ENV=production; development defaults such aschange_meare tolerated elsewhere.- Everything runs as field validation when the settings object is built, so
web apps and workers (
Settings()) are covered with no extra call. OneValidationErrorlists every failing field — always-on secrets and production checks together — and never includes the rejected values. - The production checks read
app_envfrom fields validated before them;BaseSettingsdeclares it first (a subclass may redeclare it, e.g. to change the default). On plainBaseModels withoutapp_envthey are skipped.
Installation
uv pip install "csrd-models @ git+ssh://git@github.com/csrd-api/fastapi-common.git#subdirectory=packages/models"
Dependencies
None (Tier 1 — standalone)
1 maintainer
Metadata
1 maintainer
Release files for csrd-models 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| csrd_models-0.8.0.tar.gz | 13.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| csrd_models-0.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.8 kB
Release files / csrd_models-0.8.0.tar.gz
| Download URL | csrd_models-0.8.0.tar.gz |
|---|---|
| Size | 13.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e79f1bc311608e643cce03d2f986617db313be0a158909278ff81623a4fcaab6
|
|
BLAKE2b-256 checksum How to use checksums |
37212d7af3ae7134c34b6a708130f9e38875786ce2077ecfe6ff817cf1d70410
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2026.
Transparency logRelease files / csrd_models-0.8.0-py3-none-any.whl
| Download URL | csrd_models-0.8.0-py3-none-any.whl |
|---|---|
| Size | 12.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e0dae0696d0b367e898b4f55a96c979031e1a813b7737d1e2158449f7fd20c10
|
|
BLAKE2b-256 checksum How to use checksums |
4f40adacc6ba223391507ce5bed71e1e2a95b8dec0f3363ca83560221e65e185
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2026.
Transparency log
