Merge pull request #10 from jordantshaw/rc-0.2.0

RC-0.2.0

README.md

@@ -4,6 +4,14 @@ Support for Pydantic settings configuration file loading
 ## Installation
 `pip install pydantic-config`
 
+### Optional Dependencies
+
+Pydantic-Config has the following optional dependencies:
+  - yaml - `pip install pydantic-config[yaml]`
+  - toml - `pip install pydantic-config[toml]`
+
+You can install all the optional dependencies with `pip install pydantic-config[all]`
+
 ## Usage
 
 ```toml
@@ -13,17 +21,18 @@ description = "Test application description"
 ```
 
 ```python
-from pydantic_config import SettingsModel
+from pydantic_config import SettingsModel, SettingsConfig
 
 
 class Settings(SettingsModel):
     app_id: str = 1
     app_name: str = None
     description: str = None
     log_level: str = 'INFO'
-
-    class Config:
-        config_file = 'config.toml'
+
+    model_config = SettingsConfig(
+        config_file='config.toml',
+    )
 
 
 settings = Settings()
@@ -53,24 +62,31 @@ description = "Test application description"
 ```
 
 ```python
-from pydantic_config import SettingsModel
+from pydantic_config import SettingsModel, SettingsConfig
 
 
 class Settings(SettingsModel):
     app_id: str = 1
     app_name: str = 'App Name'
     description: str = None
     log_level: str = 'INFO'
-
-    class Config:
-        config_file = ['config.toml', 'config.json']  # The config.json file will take priority over config.toml
-
+    
+    model_config = SettingsConfig(
+        config_file=['config.toml', 'config.json']  # The config.json file will take priority over config.toml
+    )
 
 settings = Settings()
 print(settings)
 # app_id='1' app_name='Python Application' description='Description from JSON file' log_level='WARNING'
 ```
 
+## Supported file formats
+Currently, the following file formats are supported:
+  - `.yaml` _Requires `pyyaml` package_
+  - `.toml` _Requires `toml` package_
+  - `.json`
+  - `.ini`
+
 
 ## Merging
 If your configurations have existing `list` or `dict` variables the contents will be merged by default. To disable
@@ -91,15 +107,16 @@ item2 = "value2"
 ```
 
 ```python
-from pydantic_config import SettingsModel
+from pydantic_config import SettingsModel, SettingsConfig
 
 
 class Settings(SettingsModel):
     foo: dict = {}
-
-    class Config:
-        config_file = ['config.toml', 'config2.toml']
-        config_merge: bool = True
+
+    model_config = SettingsConfig(
+        config_file=['config.toml', 'config2.toml'],
+        config_merge= True,
+    )
 
 
 settings = Settings()

environment.yml

@@ -4,7 +4,7 @@ channels:
   - defaults
 dependencies:
   - python=3.10
-  - pydantic<2.0.0, >=1.10.0
+  - pydantic-settings>=2.0.1
   - toml=0.10.2
   - python-dotenv=0.21.0
   - pyyaml=6.0

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "pydantic-config"
 description = "Support for Pydantic settings configuration file loading"
-version = "0.1.2"
+version = "0.2.0"
 authors = [{name="Jordan Shaw"}]
 readme = "README.md"
 requires-python = ">=3.7"
@@ -19,24 +19,41 @@ classifiers = [
 ]
 
 dependencies = [
-    'pydantic<2.0.0, >=1.10.0',
-    'pyyaml>=6.0',
-    'python-dotenv>=0.21.0',
-    'toml>=0.10.2'
+    'pydantic-settings>=2.0.2',
+
 ]
 
 [project.optional-dependencies]
+yaml = [
+    "pyyaml>=5.1"
+]
+toml = [
+    'toml>=0.10.0'
+]
+all = [
+    'pyyaml>=5.1',
+    'toml>=0.10.0'
+]
 dev = [
-    "pytest", 'twine', 'build'
+    'pytest',
+    'twine',
+    'build',
+    'pyyaml>=5.1',
+    'python-dotenv>=0.15.0',
+    'toml>=0.10.0'
 ]
 test = [
-    "pytest"
+    'pytest',
+    'pyyaml==5.1',
+    'python-dotenv>=0.15.0',
+    'toml>=0.10.0'
 ]
 
 [project.urls]
 "Homepage" = "https://github.com/jordantshaw/pydantic-config"
 
 [tool.pytest.ini_options]
-addopts = [
-    "--import-mode=importlib",
+pythonpath = [
+  "src"
 ]
+

src/pydantic_config/__init__.py

@@ -1 +1 @@
-from .main import SettingsModel
+from .main import SettingsModel, SettingsConfig