datamaker-py 0.8.0__tar.gz → 0.10.0__tar.gz

{datamaker_py-0.8.0/src/datamaker_py.egg-info → datamaker_py-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datamaker-py
-Version: 0.8.0
+Version: 0.10.0
 Summary: The official Python library for the Automators DataMaker API.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -77,3 +77,38 @@ See [`artifacts/README.md`](artifacts/README.md) for more details.
 ## Development & Contibutions
 
 See the [contributing.md](/CONTRIBUTING.md) guide for details on how to contribute to this project.
+
+## Types
+
+Response types are **generated** from the API's OpenAPI document, not hand-written:
+
+```
+spec/openapi.json  ->  src/datamaker/generated/schema.py  ->  src/datamaker/types.py
+```
+
+Import from `datamaker.types`, which resolves each spec schema name to the class
+that really matches it:
+
+```python
+from datamaker.types import Project, Plan, Template
+
+projects: list[Project] = dm.get_projects()
+```
+
+They are `TypedDict`s, so nothing changes at runtime — methods still return the
+plain dicts `response.json()` produces, and `project["name"]` works exactly as
+before. The types are checker-only.
+
+To regenerate after the API changes:
+
+```bash
+python scripts/generate_schema.py
+```
+
+CI runs `python scripts/generate_schema.py --check` and fails if the committed
+types drift from the spec.
+
+Three schemas cannot currently be generated (`SetDetail`, `PackInstallListItem`,
+`SchemaGraphNavigation`): they are composed with `allOf`, which the generator
+merges away rather than emitting as a named class. Methods returning those keep
+`Dict`. The generator script lists them explicitly and fails if the set grows.

{datamaker_py-0.8.0 → datamaker_py-0.10.0}/README.md

@@ -66,3 +66,38 @@ See [`artifacts/README.md`](artifacts/README.md) for more details.
 ## Development & Contibutions
 
 See the [contributing.md](/CONTRIBUTING.md) guide for details on how to contribute to this project.
+
+## Types
+
+Response types are **generated** from the API's OpenAPI document, not hand-written:
+
+```
+spec/openapi.json  ->  src/datamaker/generated/schema.py  ->  src/datamaker/types.py
+```
+
+Import from `datamaker.types`, which resolves each spec schema name to the class
+that really matches it:
+
+```python
+from datamaker.types import Project, Plan, Template
+
+projects: list[Project] = dm.get_projects()
+```
+
+They are `TypedDict`s, so nothing changes at runtime — methods still return the
+plain dicts `response.json()` produces, and `project["name"]` works exactly as
+before. The types are checker-only.
+
+To regenerate after the API changes:
+
+```bash
+python scripts/generate_schema.py
+```
+
+CI runs `python scripts/generate_schema.py --check` and fails if the committed
+types drift from the spec.
+
+Three schemas cannot currently be generated (`SetDetail`, `PackInstallListItem`,
+`SchemaGraphNavigation`): they are composed with `allOf`, which the generator
+merges away rather than emitting as a named class. Methods returning those keep
+`Dict`. The generator script lists them explicitly and fails if the set grows.

{datamaker_py-0.8.0 → datamaker_py-0.10.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "datamaker-py"
-version = "0.8.0"
+version = "0.10.0"
 description = "The official Python library for the Automators DataMaker API."
 readme = "README.md"
 requires-python = ">=3.11"

datamaker_py-0.10.0/src/datamaker/generated/__init__.py

@@ -0,0 +1,7 @@
+"""Types generated from the API's OpenAPI document. Do not edit by hand.
+
+Regenerate with `python scripts/generate_schema.py`; CI fails if this drifts
+from `spec/openapi.json`.
+"""
+
+from .schema import *  # noqa: F401,F403