chore: rename classes for brevity

Author: alukach

pydantic_ssm_settings/__init__.py

@@ -1,5 +1,5 @@
-from .settings import AwsSsmBaseSettings, SsmSettingsConfigDict
-from .source import AwsSsmSettingsSource
+from .settings import SsmBaseSettings, SsmSettingsConfigDict
+from .source import SsmSettingsSource
 
-__all__ = ("AwsSsmSourceConfig", "SsmSettingsConfigDict", "AwsSsmSettingsSource")
+__all__ = ("SsmBaseSettings", "SsmSettingsConfigDict", "SsmSettingsSource")
 __version__ = "1.0.0"

pydantic_ssm_settings/settings.py

@@ -10,7 +10,7 @@
     SettingsConfigDict,
 )
 
-from .source import AwsSsmSettingsSource
+from .source import SsmSettingsSource
 
 if TYPE_CHECKING:
     from mypy_boto3_ssm.client import SSMClient
@@ -23,7 +23,7 @@ class SsmSettingsConfigDict(SettingsConfigDict):
     ssm_client: Optional["SSMClient"]
 
 
-class AwsSsmBaseSettings(BaseSettings):
+class SsmBaseSettings(BaseSettings):
     """
     Helper to configure the AWS SSM source for Pydantic settings and to pass
     options from init args to settings.
@@ -58,7 +58,7 @@ def settings_customise_sources(
         dotenv_settings: PydanticBaseSettingsSource,
         file_secret_settings: SecretsSettingsSource,
     ) -> Tuple[PydanticBaseSettingsSource, ...]:
-        ssm_settings = AwsSsmSettingsSource(
+        ssm_settings = SsmSettingsSource(
             settings_cls=settings_cls,
             ssm_prefix=self.__dict__["__ssm_prefix"],
             ssm_client=self.__dict__["__ssm_client"],

pydantic_ssm_settings/source.py

@@ -22,7 +22,7 @@ class SettingsError(ValueError):
     pass
 
 
-class AwsSsmSettingsSource(EnvSettingsSource):
+class SsmSettingsSource(EnvSettingsSource):
     def __init__(
         self,
         settings_cls: type[BaseSettings],

tests/test_main.py

@@ -4,14 +4,14 @@
 from pydantic import BaseModel
 from pydantic_settings import SettingsConfigDict
 
-from pydantic_ssm_settings import AwsSsmBaseSettings, SsmSettingsConfigDict
+from pydantic_ssm_settings import SsmBaseSettings, SsmSettingsConfigDict
 
 
-class SimpleSettings(AwsSsmBaseSettings):
+class SimpleSettings(SsmBaseSettings):
     foo: str
 
 
-class IntSettings(AwsSsmBaseSettings):
+class IntSettings(SsmBaseSettings):
     foo: str
     bar: int
 
@@ -20,7 +20,7 @@ class ChildSetting(BaseModel):
     bar: str
 
 
-class ParentSetting(AwsSsmBaseSettings):
+class ParentSetting(SsmBaseSettings):
     foo: ChildSetting
 
 
@@ -98,7 +98,7 @@ def test_ssm_parameter_json_override(ssm):
     assert settings.foo.bar == "overwritten"
 
 
-class CaseInsensitiveSettings(AwsSsmBaseSettings):
+class CaseInsensitiveSettings(SsmBaseSettings):
     model_config = SettingsConfigDict(case_sensitive=False)
     foo: str
 
@@ -109,7 +109,7 @@ def test_case_insensitivity(ssm):
     assert settings.foo == "bar"
 
 
-class CustomConfigDict(AwsSsmBaseSettings):
+class CustomConfigDict(SsmBaseSettings):
     model_config = SsmSettingsConfigDict(ssm_prefix="/asdf")
     foo: str