[PYG-274] Tutorial (#351)

* docs: include in pygen docs * build: bump
cognitedata · Nov 9, 2024 · 6f254f8 · 6f254f8
1 parent 8a1f54a
commit 6f254f8
Show file tree

Hide file tree

Showing 13 changed files with 5,041 additions and 3,919 deletions.
diff --git a/cognite/pygen/_version.py b/cognite/pygen/_version.py
@@ -1 +1 @@
-__version__ = "0.99.44"
+__version__ = "0.99.45"
diff --git a/docs-dev/docs_query.ipynb b/docs-dev/docs_query.ipynb
diff --git a/docs/docs-dev/docs_query.ipynb b/docs/docs-dev/docs_query.ipynb
diff --git a/docs/quickstart/cdf_streamlit.md b/docs/quickstart/cdf_streamlit.md
@@ -13,7 +13,7 @@ adding `cognite-pygen` to the installed packages under `settings`.
 pyodide-http==0.2.1
 cognite-sdk==7.64.8
 pydantic==1.10.7
-cognite-pygen==0.99.44
+cognite-pygen==0.99.45
 ```
 
 Note that we also set `pydantic` to a specific version. This is because `pygen` supports both `pydantic` `v1` and `v2`, but

diff --git a/examples/cognite_core/_api_client.py b/examples/cognite_core/_api_client.py
@@ -50,7 +50,7 @@ class CogniteCoreClient:
     CogniteCoreClient
 
     Generated with:
-        pygen = 0.99.44
+        pygen = 0.99.45
         cognite-sdk = 7.64.8
         pydantic = 2.9.2
 
@@ -68,7 +68,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.44"
+        client.config.client_name = "CognitePygen:0.99.45"
 
         self._client = client
 

diff --git a/examples/equipment_unit/_api_client.py b/examples/equipment_unit/_api_client.py
@@ -23,7 +23,7 @@ class EquipmentUnitClient:
     EquipmentUnitClient
 
     Generated with:
-        pygen = 0.99.44
+        pygen = 0.99.45
         cognite-sdk = 7.64.8
         pydantic = 2.9.2
 
@@ -41,7 +41,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.44"
+        client.config.client_name = "CognitePygen:0.99.45"
 
         self._client = client
 

diff --git a/examples/omni/_api_client.py b/examples/omni/_api_client.py
@@ -41,7 +41,7 @@ class OmniClient:
     OmniClient
 
     Generated with:
-        pygen = 0.99.44
+        pygen = 0.99.45
         cognite-sdk = 7.64.8
         pydantic = 2.9.2
 
@@ -59,7 +59,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.44"
+        client.config.client_name = "CognitePygen:0.99.45"
 
         self._client = client
 

diff --git a/examples/omni_multi/_api_client.py b/examples/omni_multi/_api_client.py
@@ -111,7 +111,7 @@ class OmniMultiClient:
     OmniMultiClient
 
     Generated with:
-        pygen = 0.99.44
+        pygen = 0.99.45
         cognite-sdk = 7.64.8
         pydantic = 2.9.2
 
@@ -125,7 +125,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.44"
+        client.config.client_name = "CognitePygen:0.99.45"
 
         self.omni_multi_a = OmniMultiAAPIs(client)
         self.omni_multi_b = OmniMultiBAPIs(client)

diff --git a/examples/omni_sub/_api_client.py b/examples/omni_sub/_api_client.py
@@ -23,7 +23,7 @@ class OmniSubClient:
     OmniSubClient
 
     Generated with:
-        pygen = 0.99.44
+        pygen = 0.99.45
         cognite-sdk = 7.64.8
         pydantic = 2.9.2
 
@@ -41,7 +41,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.44"
+        client.config.client_name = "CognitePygen:0.99.45"
 
         self._client = client
 

diff --git a/examples/scenario_instance/client/_api_client.py b/examples/scenario_instance/client/_api_client.py
@@ -21,7 +21,7 @@ class ScenarioInstanceClient:
     ScenarioInstanceClient
 
     Generated with:
-        pygen = 0.99.44
+        pygen = 0.99.45
         cognite-sdk = 7.64.8
         pydantic = 2.9.2
 
@@ -39,7 +39,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.44"
+        client.config.client_name = "CognitePygen:0.99.45"
 
         self._client = client
 

diff --git a/examples/windmill/_api_client.py b/examples/windmill/_api_client.py
@@ -31,7 +31,7 @@ class WindmillClient:
     WindmillClient
 
     Generated with:
-        pygen = 0.99.44
+        pygen = 0.99.45
         cognite-sdk = 7.64.8
         pydantic = 2.9.2
 
@@ -49,7 +49,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.44"
+        client.config.client_name = "CognitePygen:0.99.45"
 
         self._client = client
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -50,7 +50,8 @@ nav:
         - Windmill Client: example_docs/wind_client.md
         - Windmill APIs: example_docs/wind_apis.md
         - Windmill Data Classes: example_docs/wind_data_classes.md
-
+    - Developer Docs:
+        - Querying: docs-dev/docs_query.ipynb
     - Reference - Code API:
         - Pygen: api/api.md
         - Demo: api/demo.md

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cognite-pygen"
-version = "0.99.44"
+version = "0.99.45"
 description = "Cognite Python SDK Generator"
 readme = "README.md"
 authors = ["Cognite <[email protected]>"]