v67

Author: overgodofchaos

README.md

@@ -8,6 +8,34 @@ Argument parser based on pydantic v2.
 pip install pydantic-argparse-next
 ```
 
+### Base usage:
+
+# 
+
+```python
+from pydantic import BaseModel, Field
+import pydantic_argparse_next as pa
+
+
+class Temp(BaseModel):
+    # Positional arguments
+    a: str = pa.Arg(description="This is a required positional argument.")
+    b: str = pa.Arg("defalut_value", description="This is a OPTIONAL positional argument.")
+
+    # Keyword arguments
+    # Simple attributes or pydantic.Field are keyword arguments.
+    c: str
+    d: str = Field(None, description="This is a OPTIONAL keyword argument.")
+    e: str = pa.KwArg(description="This is a required keyword argument.")
+```
+
+```
+Input: appname "test1" --c "test2" --e="test3"
+Output: a='test1' b='defalut_value' c='test2' d=None e='test3'
+```
+
+ **More details in the documentation**
+
 ### Supports:
 
 ✅ Positional arguments
@@ -46,6 +74,8 @@ pip install pydantic-argparse-next
 
         ⬜ Easy load config from file
 
+**More details in the documentation**
+
 ### Docs and examples:
 
 1. [Base usage](https://github.com/overgodofchaos/pydantic-argparse-next/blob/main/docs/BaseUsage.md)

examples/Base/example_0.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel, Field
+import pydantic_argparse_next as pa
+
+
+class Temp(BaseModel):
+    # Positional arguments
+    a: str = pa.Arg(description="This is a required positional argument.")
+    b: str = pa.Arg("defalut_value", description="This is a OPTIONAL positional argument.")
+
+    # Keyword arguments
+    # Simple attributes or pydantic.Field are keyword arguments.
+    c: str
+    d: str = Field(None, description="This is a OPTIONAL keyword argument.")
+    e: str = pa.KwArg(description="This is a required keyword argument.")
+
+
+cliargs = pa.parse(Temp, program_name="Example program", description="The example program description")
+
+print(cliargs)

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "pydantic-argparse-next"
-version = "1.0.4"
+version = "1.0.5"
 description = "Pydantic 2 argparse."
 readme = "README.md"
 requires-python = ">=3.11"