Introduce versioning: All models moved from maloident ➡️ `maloident…

….v1` (#25)
Hochfrequenz · Nov 15, 2024 · e54a9c0 · e54a9c0
1 parent 1ff4037
commit e54a9c0
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -25,7 +25,8 @@ pip install maloident
 Then use it:
 
 ```python
-from maloident.models import ResultNegative
+from maloident.v1.models import ResultNegative
+
 my_json = {
     "decisionTree": "E_0594",
     "responseCode": "A10",
@@ -42,10 +43,10 @@ See the [tests](unittests/test_models.py) for more examples.
 ## Project Structure
 
 This project is based on [`datamodel-code-generator`](https://github.com/koxudaxi/datamodel-code-generator/).
-Most of the classes are autogenerated from the [`openapi.yml`](openapi/openapi.yml) which can be found on [SwaggerHub](https://app.swaggerhub.com/apis/edi-energy/MaLoIdent_2024-07-03/v1.0.0).
+Most of the classes are autogenerated from the [`openapi.yml`](openapi/v1/openapi.yml) which can be found on [SwaggerHub](https://app.swaggerhub.com/apis/edi-energy/MaLoIdent_2024-07-03/v1.0.0).
 
 Note that we fixed some errors in the official OpenAPI spec.
-Our changes are mentioned at the beginning of the [`openapi.yml`](openapi/openapi.yml) file.
+Our changes are mentioned at the beginning of the [`openapi.yml`](openapi/v1/openapi.yml) file.
 
 https://github.com/Hochfrequenz/malo-ident-python-models/blob/3cfe0aea3cff051303ef5e513d06ab6c5741f21a/openapi/openapi.yml#L4-L10
 

diff --git a/openapi/openapi.yml → openapi/v1/openapi.yml b/openapi/openapi.yml → openapi/v1/openapi.yml
diff --git a/pyproject.toml b/pyproject.toml
@@ -75,7 +75,7 @@ truethy-bool = true
 disable_error_code = []
 
 [[tool.mypy.overrides]]
-module = "maloident._autogenerated"
+module = "maloident.v1._autogenerated"
 ignore_errors = true
 
 

diff --git a/src/maloident/v1/__init__.py b/src/maloident/v1/__init__.py
@@ -0,0 +1,5 @@
+"""
+v1 contains the models of the v1 API.
+This allows us to maintain different versions of the models (for different API versions)
+in the same python/pip package/repository.
+"""
diff --git a/src/maloident/_autogenerated.py → src/maloident/v1/_autogenerated.py b/src/maloident/_autogenerated.py → src/maloident/v1/_autogenerated.py
@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.yml
-#   timestamp: 2024-10-02T11:57:20+00:00
+#   timestamp: 2024-10-02T12:07:18+00:00
 
 from __future__ import annotations
 

diff --git a/src/maloident/models.py → src/maloident/v1/models.py b/src/maloident/models.py → src/maloident/v1/models.py
diff --git a/tox.ini b/tox.ini
@@ -75,9 +75,9 @@ deps =
     .[formatting]
     .[codegen]
 commands =
-    datamodel-codegen --encoding utf-8 --input openapi/openapi.yml --output src/maloident/_autogenerated.py --input-file-type openapi --output-model-type pydantic_v2.BaseModel
-    black src/maloident/_autogenerated.py
-    isort src/maloident/_autogenerated.py
+    datamodel-codegen --encoding utf-8 --input openapi/v1/openapi.yml --output src/maloident/v1/_autogenerated.py --input-file-type openapi --output-model-type pydantic_v2.BaseModel
+    black src/maloident/v1/_autogenerated.py
+    isort src/maloident/v1/_autogenerated.py
 
 [testenv:dev]
 # the dev environment contains everything you need to start developing on your local machine.

diff --git a/unittests/example_jsons.py → unittests/example_jsons_v1.py b/unittests/example_jsons.py → unittests/example_jsons_v1.py
diff --git a/unittests/test_models.py → unittests/test_models_v1.py b/unittests/test_models.py → unittests/test_models_v1.py
@@ -2,9 +2,9 @@
 
 import pytest
 
-from maloident.models import IdentificationParameter, ResultNegative, ResultPositive
+from maloident.v1.models import IdentificationParameter, ResultNegative, ResultPositive
 
-from .example_jsons import negative_response_body, positive_response_body, request_body
+from .example_jsons_v1 import negative_response_body, positive_response_body, request_body
 
 
 @pytest.mark.parametrize(