-
-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
featureNew feature or requestNew feature or requestinsidersCandidate for InsidersCandidate for Insiders
Description
It would be highly beneficial to add support for pydantic-settings
within griffe-pydantic. Currently, griffe-pydantic effectively handles Pydantic BaseModel
classes, but lacks the ability to process pydantic_settings.BaseSettings
classes.
https://docs.pydantic.dev/latest/concepts/pydantic_settings/
Motivation:
pydantic-settings
is widely used for managing application configurations, particularly in modern Python projects. Integrating it with griffe-pydantic would:
- Simplify Configuration Documentation: Enable automatic generation of documentation for settings models, including environment variable names, default values, and validation constraints.
- Enhance Developer Experience: Provide a consistent and streamlined approach to documenting both data models and configuration settings within Pydantic-based projects.
- Improve Code Maintainability: Ensure that configuration settings are documented alongside the rest of the codebase, reducing the risk of inconsistencies.
sebpretzer
Metadata
Metadata
Assignees
Labels
featureNew feature or requestNew feature or requestinsidersCandidate for InsidersCandidate for Insiders