UncountablePythonSDK 0.0.100__tar.gz → 0.0.142__tar.gz

{uncountablepythonsdk-0.0.100 → uncountablepythonsdk-0.0.142}/.github/workflows/documentation.yml

@@ -10,14 +10,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
-      - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5
+      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
       - uses: extractions/setup-crate@4993624604c307fbca528d28a3c8b60fa5ecc859 # v1
         with:
           repo: casey/just@0.10
+      - name: Set up UV
+        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb
+        with:
+          version: "0.9.5"
+          activate-environment: true
+          enable-cache: true
       - name: Install dependencies
         run: |
           # install the dependencies for the package
-          pip install .
+          uv pip install .
           # install the dependencies for building the sphinx documentation
           just -f docs/justfile docs-setup-python
       - name: Sphinx build

{uncountablepythonsdk-0.0.100 → uncountablepythonsdk-0.0.142}/.github/workflows/publish.yml

@@ -22,14 +22,22 @@ jobs:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5
+          tags: true
+      - name: Set up UV
+        uses: astral-sh/setup-uv@f0ec1fc3b38f5e7cd731bb6ce540c5af426746bb
         with:
-          python-version: '3.11'
+          version: "0.9.5"
+          activate-environment: true
+          enable-cache: true
       - name: Install build dependencies
         run: |
-          python3 -m pip install --upgrade build
+          uv pip install --upgrade build
+      - name: Show changes
+        run: |
+          git status
       - name: Build distributions and wheels
         run: |
+          export SETUPTOOLS_SCM_PRETEND_VERSION_FOR_uncountablepythonsdk=$(git describe --tags --exact-match)
           python3 -m build
       - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4
         with:
@@ -45,9 +53,9 @@ jobs:
     permissions:
       id-token: write
     steps:
-    - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4
+    - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
       with:
         name: package-distributions
         path: dist/
     - name: Publish package distributions to PyPI
-      uses: pypa/gh-action-pypi-publish@fb9fc6a4e67ca27a7a76b17bbf90be83c2d3c716
+      uses: pypa/gh-action-pypi-publish@db8f07d3871a0a180efa06b95d467625c19d5d5f

uncountablepythonsdk-0.0.142/.python-version

@@ -0,0 +1 @@
+3.13.5

{uncountablepythonsdk-0.0.100/UncountablePythonSDK.egg-info → uncountablepythonsdk-0.0.142}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.100
+Version: 0.0.142
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git
@@ -38,13 +38,17 @@ Requires-Dist: simplejson==3.*
 Requires-Dist: grpcio==1.67.1
 Requires-Dist: protobuf>=4.21.1
 Requires-Dist: azure-storage-blob==12.*
-Requires-Dist: boto3-stubs[essential,ses]==1.36.4
+Requires-Dist: boto3-stubs[essential,ses]==1.*
+Requires-Dist: msgspec==0.19.*
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: types-psutil~=5.9.5
+Requires-Dist: psutil>=5.9.0
 Provides-Extra: test
 Requires-Dist: mypy==1.*; extra == "test"
 Requires-Dist: ruff==0.*; extra == "test"
 Requires-Dist: pytest==8.*; extra == "test"
 Requires-Dist: coverage[toml]==7.*; extra == "test"
-Requires-Dist: pytest-cov==6.*; extra == "test"
+Requires-Dist: pytest-cov==7.*; extra == "test"
 Requires-Dist: pytest-xdist==3.*; extra == "test"
 
 # Uncountable Python SDK

{uncountablepythonsdk-0.0.100 → uncountablepythonsdk-0.0.142/UncountablePythonSDK.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.100
+Version: 0.0.142
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git
@@ -38,13 +38,17 @@ Requires-Dist: simplejson==3.*
 Requires-Dist: grpcio==1.67.1
 Requires-Dist: protobuf>=4.21.1
 Requires-Dist: azure-storage-blob==12.*
-Requires-Dist: boto3-stubs[essential,ses]==1.36.4
+Requires-Dist: boto3-stubs[essential,ses]==1.*
+Requires-Dist: msgspec==0.19.*
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: types-psutil~=5.9.5
+Requires-Dist: psutil>=5.9.0
 Provides-Extra: test
 Requires-Dist: mypy==1.*; extra == "test"
 Requires-Dist: ruff==0.*; extra == "test"
 Requires-Dist: pytest==8.*; extra == "test"
 Requires-Dist: coverage[toml]==7.*; extra == "test"
-Requires-Dist: pytest-cov==6.*; extra == "test"
+Requires-Dist: pytest-cov==7.*; extra == "test"
 Requires-Dist: pytest-xdist==3.*; extra == "test"
 
 # Uncountable Python SDK

{uncountablepythonsdk-0.0.100 → uncountablepythonsdk-0.0.142}/UncountablePythonSDK.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 .gitignore
+.python-version
 README.md
 pyproject.toml
 .github/workflows/documentation.yml
@@ -12,8 +13,10 @@ docs/.gitignore
 docs/conf.py
 docs/index.md
 docs/justfile
-docs/quickstart.md
 docs/requirements.txt
+docs/integration_examples/create_ingredient.md
+docs/integration_examples/create_output.md
+docs/integration_examples/index.md
 docs/static/logo_blue.png
 docs/static/favicons/android-chrome-192x192.png
 docs/static/favicons/android-chrome-512x512.png
@@ -25,15 +28,24 @@ docs/static/favicons/manifest.json
 docs/static/favicons/mstile-150x150.png
 docs/static/favicons/safari-pinned-tab.svg
 examples/async_batch.py
+examples/basic_auth.py
 examples/create_entity.py
+examples/create_ingredient_sdk.py
 examples/download_files.py
 examples/edit_recipe_inputs.py
 examples/invoke_uploader.py
+examples/oauth.py
 examples/set_recipe_metadata_file.py
 examples/set_recipe_output_file_sdk.py
 examples/upload_files.py
 examples/integration-server/pyproject.toml
+examples/integration-server/jobs/materials_auto/concurrent_cron.py
 examples/integration-server/jobs/materials_auto/example_cron.py
+examples/integration-server/jobs/materials_auto/example_http.py
+examples/integration-server/jobs/materials_auto/example_instrument.py
+examples/integration-server/jobs/materials_auto/example_parse.py
+examples/integration-server/jobs/materials_auto/example_predictions.py
+examples/integration-server/jobs/materials_auto/example_runsheet_wh.py
 examples/integration-server/jobs/materials_auto/example_wh.py
 examples/integration-server/jobs/materials_auto/profile.yaml
 pkgs/__init__.py
@@ -70,6 +82,7 @@ pkgs/strenum_compat/strenum_compat.py
 pkgs/type_spec/__init__.py
 pkgs/type_spec/__main__.py
 pkgs/type_spec/builder.py
+pkgs/type_spec/builder_types.py
 pkgs/type_spec/config.py
 pkgs/type_spec/cross_output_links.py
 pkgs/type_spec/emit_io_ts.py
@@ -79,6 +92,7 @@ pkgs/type_spec/emit_python.py
 pkgs/type_spec/emit_typescript.py
 pkgs/type_spec/emit_typescript_util.py
 pkgs/type_spec/load_types.py
+pkgs/type_spec/non_discriminated_union_exceptions.py
 pkgs/type_spec/open_api_util.py
 pkgs/type_spec/test.py
 pkgs/type_spec/util.py
@@ -89,6 +103,8 @@ pkgs/type_spec/parts/base.py.prepart
 pkgs/type_spec/parts/base.ts.prepart
 pkgs/type_spec/type_info/__main__.py
 pkgs/type_spec/type_info/emit_type_info.py
+pkgs/type_spec/ui_entry_actions/__init__.py
+pkgs/type_spec/ui_entry_actions/generate_ui_entry_actions.py
 pkgs/type_spec/value_spec/__init__.py
 pkgs/type_spec/value_spec/__main__.py
 pkgs/type_spec/value_spec/convert_type.py
@@ -119,6 +135,8 @@ uncountable/integration/executors/__init__.py
 uncountable/integration/executors/executors.py
 uncountable/integration/executors/generic_upload_executor.py
 uncountable/integration/executors/script_executor.py
+uncountable/integration/http_server/__init__.py
+uncountable/integration/http_server/types.py
 uncountable/integration/queue_runner/__init__.py
 uncountable/integration/queue_runner/job_scheduler.py
 uncountable/integration/queue_runner/queue_runner.py
@@ -127,6 +145,7 @@ uncountable/integration/queue_runner/worker.py
 uncountable/integration/queue_runner/command_server/__init__.py
 uncountable/integration/queue_runner/command_server/command_client.py
 uncountable/integration/queue_runner/command_server/command_server.py
+uncountable/integration/queue_runner/command_server/constants.py
 uncountable/integration/queue_runner/command_server/types.py
 uncountable/integration/queue_runner/command_server/protocol/__init__.py
 uncountable/integration/queue_runner/command_server/protocol/command_server.proto
@@ -159,10 +178,14 @@ uncountable/types/client_config.py
 uncountable/types/client_config_t.py
 uncountable/types/curves.py
 uncountable/types/curves_t.py
+uncountable/types/data.py
+uncountable/types/data_t.py
 uncountable/types/entity.py
 uncountable/types/entity_t.py
 uncountable/types/experiment_groups.py
 uncountable/types/experiment_groups_t.py
+uncountable/types/exports.py
+uncountable/types/exports_t.py
 uncountable/types/field_values.py
 uncountable/types/field_values_t.py
 uncountable/types/fields.py
@@ -179,8 +202,18 @@ uncountable/types/inputs.py
 uncountable/types/inputs_t.py
 uncountable/types/integration_server.py
 uncountable/types/integration_server_t.py
+uncountable/types/integration_session.py
+uncountable/types/integration_session_t.py
+uncountable/types/integrations.py
+uncountable/types/integrations_t.py
 uncountable/types/job_definition.py
 uncountable/types/job_definition_t.py
+uncountable/types/listing.py
+uncountable/types/listing_t.py
+uncountable/types/notices.py
+uncountable/types/notices_t.py
+uncountable/types/notifications.py
+uncountable/types/notifications_t.py
 uncountable/types/outputs.py
 uncountable/types/outputs_t.py
 uncountable/types/overrides.py
@@ -213,8 +246,12 @@ uncountable/types/response.py
 uncountable/types/response_t.py
 uncountable/types/secret_retrieval.py
 uncountable/types/secret_retrieval_t.py
+uncountable/types/sockets.py
+uncountable/types/sockets_t.py
 uncountable/types/units.py
 uncountable/types/units_t.py
+uncountable/types/uploader.py
+uncountable/types/uploader_t.py
 uncountable/types/users.py
 uncountable/types/users_t.py
 uncountable/types/webhook_job.py
@@ -227,15 +264,21 @@ uncountable/types/api/batch/execute_batch.py
 uncountable/types/api/batch/execute_batch_load_async.py
 uncountable/types/api/chemical/__init__.py
 uncountable/types/api/chemical/convert_chemical_formats.py
+uncountable/types/api/condition_parameters/__init__.py
+uncountable/types/api/condition_parameters/upsert_condition_match.py
 uncountable/types/api/entity/__init__.py
 uncountable/types/api/entity/create_entities.py
 uncountable/types/api/entity/create_entity.py
 uncountable/types/api/entity/create_or_update_entity.py
+uncountable/types/api/entity/export_entities.py
 uncountable/types/api/entity/get_entities_data.py
 uncountable/types/api/entity/grant_entity_permissions.py
+uncountable/types/api/entity/list_aggregate.py
 uncountable/types/api/entity/list_entities.py
 uncountable/types/api/entity/lock_entity.py
+uncountable/types/api/entity/lookup_entity.py
 uncountable/types/api/entity/resolve_entity_ids.py
+uncountable/types/api/entity/set_barcode.py
 uncountable/types/api/entity/set_entity_field_values.py
 uncountable/types/api/entity/set_values.py
 uncountable/types/api/entity/transition_entity_phase.py
@@ -260,11 +303,20 @@ uncountable/types/api/inputs/set_input_attribute_values.py
 uncountable/types/api/inputs/set_input_category.py
 uncountable/types/api/inputs/set_input_subcategories.py
 uncountable/types/api/inputs/set_intermediate_type.py
+uncountable/types/api/integrations/__init__.py
+uncountable/types/api/integrations/publish_realtime_data.py
+uncountable/types/api/integrations/push_notification.py
+uncountable/types/api/integrations/register_sockets_token.py
+uncountable/types/api/listing/__init__.py
+uncountable/types/api/listing/fetch_listing.py
 uncountable/types/api/material_families/__init__.py
 uncountable/types/api/material_families/update_entity_material_families.py
+uncountable/types/api/notebooks/__init__.py
+uncountable/types/api/notebooks/add_notebook_content.py
 uncountable/types/api/outputs/__init__.py
 uncountable/types/api/outputs/get_output_data.py
 uncountable/types/api/outputs/get_output_names.py
+uncountable/types/api/outputs/get_output_organization.py
 uncountable/types/api/outputs/resolve_output_conditions.py
 uncountable/types/api/permissions/__init__.py
 uncountable/types/api/permissions/set_core_permissions.py
@@ -278,10 +330,12 @@ uncountable/types/api/recipe_metadata/__init__.py
 uncountable/types/api/recipe_metadata/get_recipe_metadata_data.py
 uncountable/types/api/recipes/__init__.py
 uncountable/types/api/recipes/add_recipe_to_project.py
+uncountable/types/api/recipes/add_time_series_data.py
 uncountable/types/api/recipes/archive_recipes.py
 uncountable/types/api/recipes/associate_recipe_as_input.py
 uncountable/types/api/recipes/associate_recipe_as_lot.py
 uncountable/types/api/recipes/clear_recipe_outputs.py
+uncountable/types/api/recipes/create_mix_order.py
 uncountable/types/api/recipes/create_recipe.py
 uncountable/types/api/recipes/create_recipes.py
 uncountable/types/api/recipes/disassociate_recipe_as_input.py
@@ -301,9 +355,16 @@ uncountable/types/api/recipes/set_recipe_output_annotations.py
 uncountable/types/api/recipes/set_recipe_output_file.py
 uncountable/types/api/recipes/set_recipe_outputs.py
 uncountable/types/api/recipes/set_recipe_tags.py
+uncountable/types/api/recipes/set_recipe_total.py
 uncountable/types/api/recipes/unarchive_recipes.py
 uncountable/types/api/recipes/unlock_recipes.py
+uncountable/types/api/runsheet/__init__.py
+uncountable/types/api/runsheet/complete_async_upload.py
+uncountable/types/api/runsheet/export_default_runsheet.py
 uncountable/types/api/triggers/__init__.py
 uncountable/types/api/triggers/run_trigger.py
 uncountable/types/api/uploader/__init__.py
-uncountable/types/api/uploader/invoke_uploader.py
+uncountable/types/api/uploader/complete_async_parse.py
+uncountable/types/api/uploader/invoke_uploader.py
+uncountable/types/api/user/__init__.py
+uncountable/types/api/user/get_current_user_info.py

{uncountablepythonsdk-0.0.100 → uncountablepythonsdk-0.0.142}/UncountablePythonSDK.egg-info/requires.txt

@@ -20,12 +20,16 @@ simplejson==3.*
 grpcio==1.67.1
 protobuf>=4.21.1
 azure-storage-blob==12.*
-boto3-stubs[essential,ses]==1.36.4
+boto3-stubs[essential,ses]==1.*
+msgspec==0.19.*
+tabulate==0.9.0
+types-psutil~=5.9.5
+psutil>=5.9.0
 
 [test]
 mypy==1.*
 ruff==0.*
 pytest==8.*
 coverage[toml]==7.*
-pytest-cov==6.*
+pytest-cov==7.*
 pytest-xdist==3.*

uncountablepythonsdk-0.0.142/docs/conf.py

@@ -0,0 +1,104 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import datetime
+
+from docutils import nodes  # type: ignore[import-untyped]
+from sphinx.addnodes import pending_xref  # type: ignore[import-not-found]
+from sphinx.application import Sphinx  # type: ignore[import-not-found]
+from sphinx.environment import BuildEnvironment  # type: ignore[import-not-found]
+
+project = "Uncountable SDK"
+copyright = f"{datetime.datetime.now(tz=datetime.UTC).date().year}, Uncountable Inc"
+author = "Uncountable Inc"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "autoapi.extension",
+    "myst_parser",
+    "sphinx_design",
+    "sphinx_copybutton",
+    "sphinx_favicon",
+]
+myst_enable_extensions = ["fieldlist", "deflist", "colon_fence"]
+
+autoapi_dirs = ["../uncountable"]
+autoapi_options = [
+    "members",
+    "inherited-members",
+    "undoc-members",
+]
+autoapi_root = "api"
+autoapi_ignore = ["*integration*"]
+autodoc_typehints = "description"
+autoapi_member_order = "groupwise"
+autoapi_own_page_level = "class"
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+python_use_unqualified_type_names = True
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_title = "Python SDK"
+html_static_path = ["static"]
+html_logo = "static/logo_blue.png"
+
+favicons = [
+    "favicons/android-chrome-192x192.png",
+    "favicons/android-chrome-512x512.png",
+    "favicons/apple-touch-icon.png",
+    "favicons/favicon-16x16.png",
+    "favicons/favicon-32x32.png",
+    "favicons/mstile-150x150.png",
+    "favicons/safari-pinned-tab.svg",
+]
+
+
+def _hook_missing_reference(
+    _app: Sphinx, _env: BuildEnvironment, node: pending_xref, contnode: nodes.Text
+) -> nodes.reference | None:
+    """
+    Manually resolve reference when autoapi reference resolution fails.
+    This is necessary because autoapi does not fully support type aliases.
+    """
+    # example reftarget value: uncountable.types.identifier_t.IdentifierKey
+    target = node.get("reftarget", "")
+
+    # example refdoc value: api/uncountable/types/generic_upload_t/GenericUploadStrategy
+    current_doc = node.get("refdoc", "")
+
+    if not target.startswith("uncountable"):
+        return None
+
+    target_module, target_name = target.rsplit(".", 1)
+
+    # construct relative path from current doc page to target page
+    relative_segments_to_root = [".." for _ in current_doc.split("/")]
+    relative_segments_to_target = target_module.split(".")
+
+    # example full relative path: ../../../../../api/uncountable/types/identifier_t/#uncountable.types.identifier_t.IdentifierKey
+    full_relative_path = "/".join([
+        *relative_segments_to_root,
+        autoapi_root,
+        *relative_segments_to_target,
+        f"#{target}",
+    ])
+
+    return nodes.reference(
+        text=target_name if python_use_unqualified_type_names else target,
+        children=[contnode],
+        refuri=full_relative_path,
+    )
+
+
+def setup(app: Sphinx) -> None:
+    app.connect("missing-reference", _hook_missing_reference)

uncountablepythonsdk-0.0.142/docs/index.md

@@ -0,0 +1,116 @@
+# Uncountable Python SDK
+
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/UncountablePythonSDK)
+
+
+The Uncountable Python SDK is a python package that provides a wrapper around the Uncountable REST API.
+
+Using this SDK provides the following advantages:
+
+- In-editor parameter/type safety
+- Automatic parsing of response data.
+- Reduced code boilerplate
+- Helper methods
+
+## Getting Started
+The first step in any integration is to create a [Client](uncountable.core.client.Client) object. The client provides access to all available SDK methods, and includes built-in request authentication & error propagation.
+
+### Creating a Client
+Create a client using one of the supported authentication mechanisms. API credentials can be generated by a member of Uncountable staff.
+
+::::{tab-set}
+:::{tab-item} Basic Auth
+```{literalinclude} ../examples/basic_auth.py
+```
+:::
+
+:::{tab-item} OAuth
+```{literalinclude} ../examples/oauth.py
+```
+:::
+::::
+
+The provided code examples assume that a Client has been created and stored in the `client` variable
+
+
+### Basic Usage
+
+:::{dropdown} List Ingredient Names & IDs
+```{code-block} python
+from uncountable.types import entity_t, id_source_t
+
+client.list_id_source(
+    spec=id_source_t.IdSourceSpecEntity(entity_type=entity_t.EntityType.INGREDIENT),
+    search_label="",
+)
+```
+Example Response:
+```code
+Data(
+    results=[
+        IdName(id=1, name='Filler'), 
+        IdName(id=2, name='Calcium Oxide 2'), 
+        IdName(id=3, name='Carbon Black'),
+    ]
+)
+```
+:::
+
+:::{dropdown} Create an Experiment
+```{code-block} python
+client.create_recipe(material_family_id=1, workflow_id=1, name="Example Recipe")
+```
+Example Response:
+```code
+Data(result_id=52271)
+```
+:::
+
+:::{dropdown} Upload a file
+```{code-block} python
+from uncountable.core.file_upload import MediaFileUpload
+
+client.upload_files(file_uploads=[MediaFileUpload(path="/path/to/local/example_file.pdf")])
+```
+Example Response:
+```code
+[
+    UploadedFile(name='example_file.pdf', file_id=718)
+]
+```
+:::
+
+[More examples](integration_examples/index)
+
+## Errors
+Client methods will raise Exceptions when the API returns codes in the `3xx`, `4xx` or `5xx` ranges. Ensure all method calls are wrapped in Exception handling logic.
+
+## Pagination
+Many of the Uncountable APIs require pagination to fetch more than 100 results at once. The following code snippet implements pagination to fetch the Names & IDs of all Projects:
+:::{dropdown} Pagination Example
+```{code-block} python
+from uncountable.types import entity_t, id_source_t
+from uncountable.types.api.id_source.list_id_source import IdName
+
+def fetch_all_projects(client: Client) -> list[IdName]:
+    projects: list[IdName] = []
+    while True:
+        response = client.list_id_source(
+            spec=IdSourceSpecEntity(entity_type=entity_t.EntityType.PROJECT),
+            search_label="",
+            offset=len(projects),
+        )
+        projects.extend(response.results)
+        if len(response.results) < 100:
+            return projects
+```
+:::
+
+
+```{toctree}
+:hidden:
+Overview <self>
+Available SDK Methods <api/uncountable/core/client/Client>
+integration_examples/index
+SDK Reference <api/uncountable/index>
+```

uncountablepythonsdk-0.0.142/docs/integration_examples/create_ingredient.md

@@ -0,0 +1,43 @@
+# Create an Ingredient
+
+Use the `create_or_update_entity` method to create Ingredients.
+
+The following fields are required when creating an Ingredient:
+- `name`: The name of the Ingredient
+- `core_ingredient_ingredientMaterialFamilies`: The list of material families in which to include the Ingredient
+
+The reference name of the default definition of Ingredients is `uncIngredient`
+
+This is an example of a minimal ingredient creation call
+
+```{code-block} python
+from uncountable.types import entity_t, field_values_t, identifier_t
+
+client.create_or_update_entity(
+    entity_type=entity_t.EntityType.INGREDIENT,
+    definition_key=identifier_t.IdentifierKeyRefName(ref_name="uncIngredient"),
+    field_values=[
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(
+                ref_name="core_ingredient_ingredientMaterialFamilies"
+            ),
+            value=field_values_t.FieldValueIds(
+                entity_type=entity_t.EntityType.MATERIAL_FAMILY,
+                identifier_keys=[identifier_t.IdentifierKeyId(id=1)],
+            ),
+        ),
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(ref_name="name"),
+            value=field_values_t.FieldValueText(value="Example Ingredient"),
+        ),
+    ],
+)
+```
+
+Example Response:
+```{code}
+Data(modification_made=True, result_id=3124, entity=None, result_values=None)
+```
+
+Optional fields:
+- `core_ingredient_quantityType`: The quantity type of the ingredient (default is `numeric`)

uncountablepythonsdk-0.0.142/docs/integration_examples/create_output.md

@@ -0,0 +1,56 @@
+# Create an Output
+
+Use the `create_or_update_entity` method to create Outputs.
+
+The following fields are required when creating an Output:
+- `name`: The name of the Output
+- `core_output_unitsId`: The unit the output is measured in
+- `core_output_outputMaterialFamilies`: The list of material families in which to include the Output
+- `core_output_quantityType`: The quantity type of the output
+
+The reference name of the default definition of Ingredients is `unc_output_definition`
+
+This is an example of a minimal output creation call
+
+```{code-block} python
+from uncountable.types import entity_t, field_values_t, identifier_t
+
+client.create_or_update_entity(
+    entity_type=entity_t.EntityType.OUTPUT,
+    definition_key=identifier_t.IdentifierKeyRefName(ref_name="unc_output_definition"),
+    field_values=[
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(ref_name="name"),
+            value=field_values_t.FieldValueText(value="Example Output"),
+        ),
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(ref_name="core_output_unitsId"),
+            value=field_values_t.FieldValueId(
+                entity_type=entity_t.EntityType.UNITS,
+                identifier_key=identifier_t.IdentifierKeyId(id=1),
+            ),
+        ),
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(
+                ref_name="core_output_outputMaterialFamilies"
+            ),
+            value=field_values_t.FieldValueIds(
+                entity_type=entity_t.EntityType.MATERIAL_FAMILY,
+                identifier_keys=[identifier_t.IdentifierKeyId(id=1)],
+            ),
+        ),
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(
+                ref_name="core_output_quantityType"
+            ),
+            value=field_values_t.FieldValueFieldOption(value="numeric"),
+        ),
+    ],
+)
+```
+
+Example Response:
+
+```{code}
+Data(modification_made=True, result_id=653, entity=None, result_values=None)
+```

uncountablepythonsdk-0.0.142/docs/integration_examples/index.md

@@ -0,0 +1,6 @@
+# Integration Examples
+
+```{toctree}
+create_ingredient
+create_output
+```