docs(examples): started on providing more examples

trialandsuccess · Jun 14, 2023 · ca84ecb · ca84ecb
1 parent 6ba4bf2
commit ca84ecb
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ pip install configuraptor
 Configuraptor can be used to load your config files into structured Python classes.
 
 ```toml
-# example_from_docs.toml
+# examples/example_from_readme.toml
 [config]
 name = "Hello World!"
 
@@ -56,10 +56,12 @@ string = "42"
 ```
 
 Could be loaded into Python classes using the following code:
+
 ```python
-# example_from_docs.py
+# examples/example_from_readme.py
 from configuraptor import load_into, TypedConfig
 
+
 ######################
 # with basic classes #
 ######################
@@ -76,7 +78,7 @@ class Config:
 
 
 if __name__ == '__main__':
-    my_config = load_into(Config, "example_from_docs.toml")  # or .json, .yaml
+    my_config = load_into(Config, "example_from_readme.toml")  # or .json, .yaml
 
     print(my_config.name)
     # Hello World!
@@ -100,15 +102,15 @@ class OtherConfig(TypedConfig):
 
 
 if __name__ == '__main__':
-    my_config = OtherConfig.load("example_from_docs.toml")  # or .json, .yaml
+    my_config = OtherConfig.load("example_from_readme.toml")  # or .json, .yaml
 
     print(my_config.name)
     # Hello World!
     print(my_config.reference.numbers)
     # [41, 43]
 ```
 
-More examples will be available soon.
+More examples can be round in [examples](https://github.com/trialandsuccess/configuraptor/blob/master/examples).
 
 ## License
 

diff --git a/examples/dataclass.py b/examples/dataclass.py
@@ -3,7 +3,7 @@
 """
 from dataclasses import dataclass
 
-from typedconfig import load_into
+from configuraptor import load_into
 
 
 @dataclass

diff --git a/examples/example_from_docs.json → examples/example_from_readme.json b/examples/example_from_docs.json → examples/example_from_readme.json
diff --git a/examples/example_from_docs.py → examples/example_from_readme.py b/examples/example_from_docs.py → examples/example_from_readme.py
@@ -16,7 +16,7 @@ class Config:
 
 
 if __name__ == '__main__':
-    my_config = load_into(Config, "example_from_docs.json")
+    my_config = load_into(Config, "example_from_readme.json")
 
     print(my_config.name)
     # Hello World!
@@ -40,7 +40,7 @@ class OtherConfig(TypedConfig):
 
 
 if __name__ == '__main__':
-    my_config = OtherConfig.load("example_from_docs.json")
+    my_config = OtherConfig.load("example_from_readme.json")
 
     print(my_config.name)
     # Hello World!

diff --git a/examples/example_from_docs.toml → examples/example_from_readme.toml b/examples/example_from_docs.toml → examples/example_from_readme.toml
diff --git a/examples/example_from_docs.yaml → examples/example_from_readme.yaml b/examples/example_from_docs.yaml → examples/example_from_readme.yaml
diff --git a/examples/main.py b/examples/main.py
@@ -2,7 +2,7 @@
 Example with basic classes
 """
 
-from typedconfig import load_into
+from configuraptor import load_into
 
 
 class AbsHasName:

diff --git a/examples/readme.md b/examples/readme.md
@@ -0,0 +1,13 @@
+# Examples
+
+## Basic
+
+## Dataclasses
+
+## Inheriting from TypedConfig
+
+## Classes with `init`
+
+## Existing Instances
+
+## Singletons