Improving backward compatibility & docs

Author: LukasGold

setup.cfg

@@ -68,6 +68,7 @@ install_requires =
     asyncio
     tqdm
     pybars3-wheel
+    backports.strenum; python_version<"3.11"
 
 [options.packages.find]
 where = src

src/osw/core.py

@@ -341,7 +341,7 @@ class FetchSchemaParam(BaseModel):
         """uses legacy command line for code generation if true"""
 
     def fetch_schema(self, fetchSchemaParam: FetchSchemaParam = None) -> None:
-        """Loads the given schemas from the OSW instance and autogenerates python
+        """Loads the given schemas from the OSW instance and auto-generates python
         datasclasses within osw.model.entity from it
 
         Parameters

src/osw/custom_types.py

@@ -8,6 +8,10 @@
     NoneType = type(None)
 else:
     from types import NoneType  # noqa: F401
+if sys.version_info < (3, 11):
+    from backports.strenum import StrEnum  # noqa: F401
+else:
+    from enum import StrEnum  # noqa: F401
 
 
 class PossibleFilePath(PydanticFilePath):

src/osw/model/static.py

@@ -85,8 +85,11 @@ def custom_isinstance(obj: Union[type, T], class_name: str) -> bool:
 class OswBaseModel(BaseModel):
 
     class Config:
+        """Configuration for the OswBaseModel"""
+
         # strict = False
-        # Additional fields are allowed
+        # extra = "ignore"
+        # Additional fields are ignored
         validate_assignment = True
         # Ensures that the assignment of a value to a field is validated