UncountablePythonSDK 0.0.15__tar.gz → 0.0.17__tar.gz

uncountablepythonsdk-0.0.17/.github/workflows/documentation.yml

@@ -0,0 +1,34 @@
+name: documentation
+
+on: [push]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: extractions/setup-just@v1
+        with:
+            just-version: '1.8.0'
+            github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Install dependencies
+        run: |
+          # install the dependencies for the package
+          pip install .
+          # install the dependencies for building the sphinx documentation
+          just -f docs/justfile docs-setup-python
+      - name: Sphinx build
+        run: |
+          just -f docs/justfile docs-build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/dirhtml
+          force_orphan: true

{UncountablePythonSDK-0.0.15 → uncountablepythonsdk-0.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.15
+Version: 0.0.17
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git
@@ -29,3 +29,17 @@ Requires-Dist: pytest>=7.4.3; extra == "test"
 Requires-Dist: coverage[toml]>=6.5.0; extra == "test"
 Requires-Dist: pytest-cov>=4.1.0; extra == "test"
 Requires-Dist: pytest-xdist>=3.5.0; extra == "test"
+
+# Uncountable Python SDK
+
+## Documentation
+[https://uncountableinc.github.io/uncountable-python-sdk/](https://uncountableinc.github.io/uncountable-python-sdk/)
+
+## Installation
+
+Install from PyPI:
+
+```console
+pip install UncountablePythonSDK
+```
+

uncountablepythonsdk-0.0.17/README.md

@@ -0,0 +1,13 @@
+# Uncountable Python SDK
+
+## Documentation
+[https://uncountableinc.github.io/uncountable-python-sdk/](https://uncountableinc.github.io/uncountable-python-sdk/)
+
+## Installation
+
+Install from PyPI:
+
+```console
+pip install UncountablePythonSDK
+```
+

{UncountablePythonSDK-0.0.15 → uncountablepythonsdk-0.0.17}/UncountablePythonSDK.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.15
+Version: 0.0.17
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git
@@ -29,3 +29,17 @@ Requires-Dist: pytest>=7.4.3; extra == "test"
 Requires-Dist: coverage[toml]>=6.5.0; extra == "test"
 Requires-Dist: pytest-cov>=4.1.0; extra == "test"
 Requires-Dist: pytest-xdist>=3.5.0; extra == "test"
+
+# Uncountable Python SDK
+
+## Documentation
+[https://uncountableinc.github.io/uncountable-python-sdk/](https://uncountableinc.github.io/uncountable-python-sdk/)
+
+## Installation
+
+Install from PyPI:
+
+```console
+pip install UncountablePythonSDK
+```
+

{UncountablePythonSDK-0.0.15 → uncountablepythonsdk-0.0.17}/UncountablePythonSDK.egg-info/SOURCES.txt

@@ -1,11 +1,29 @@
 .gitignore
+README.md
 pyproject.toml
+.github/workflows/documentation.yml
 .github/workflows/publish.yml
 UncountablePythonSDK.egg-info/PKG-INFO
 UncountablePythonSDK.egg-info/SOURCES.txt
 UncountablePythonSDK.egg-info/dependency_links.txt
 UncountablePythonSDK.egg-info/requires.txt
 UncountablePythonSDK.egg-info/top_level.txt
+docs/.gitignore
+docs/conf.py
+docs/index.md
+docs/justfile
+docs/quickstart.md
+docs/requirements.txt
+docs/static/logo_blue.png
+docs/static/favicons/android-chrome-192x192.png
+docs/static/favicons/android-chrome-512x512.png
+docs/static/favicons/apple-touch-icon.png
+docs/static/favicons/browserconfig.xml
+docs/static/favicons/favicon-16x16.png
+docs/static/favicons/favicon-32x32.png
+docs/static/favicons/manifest.json
+docs/static/favicons/mstile-150x150.png
+docs/static/favicons/safari-pinned-tab.svg
 examples/create_entity.py
 examples/recipe-import/importer.py
 pkgs/__init__.py
@@ -37,6 +55,9 @@ pkgs/type_spec/load_types.py
 pkgs/type_spec/open_api_util.py
 pkgs/type_spec/test.py
 pkgs/type_spec/util.py
+pkgs/type_spec/actions_registry/__init__.py
+pkgs/type_spec/actions_registry/__main__.py
+pkgs/type_spec/actions_registry/emit_typescript.py
 pkgs/type_spec/parts/base.py.prepart
 pkgs/type_spec/parts/base.ts.prepart
 pkgs/type_spec/type_info/__main__.py
@@ -47,6 +68,7 @@ pkgs/type_spec/value_spec/convert_type.py
 pkgs/type_spec/value_spec/emit_python.py
 pkgs/type_spec/value_spec/types.py
 type_spec/external/api/batch/execute_batch.yaml
+type_spec/external/api/chemical/convert_chemical_formats.yaml
 type_spec/external/api/entity/create_entities.yaml
 type_spec/external/api/entity/create_entity.yaml
 type_spec/external/api/entity/get_entities_data.yaml
@@ -64,7 +86,11 @@ type_spec/external/api/outputs/get_output_names.yaml
 type_spec/external/api/outputs/resolve_output_conditions.yaml
 type_spec/external/api/project/get_projects.yaml
 type_spec/external/api/project/get_projects_data.yaml
+type_spec/external/api/recipe_links/create_recipe_link.yaml
 type_spec/external/api/recipe_metadata/get_recipe_metadata_data.yaml
+type_spec/external/api/recipes/associate_recipe_as_input.yaml
+type_spec/external/api/recipes/associate_recipe_as_lot.yaml
+type_spec/external/api/recipes/create_recipe.yaml
 type_spec/external/api/recipes/create_recipes.yaml
 type_spec/external/api/recipes/get_curve.yaml
 type_spec/external/api/recipes/get_recipe_calculations.yaml
@@ -73,6 +99,7 @@ type_spec/external/api/recipes/get_recipe_names.yaml
 type_spec/external/api/recipes/get_recipe_output_metadata.yaml
 type_spec/external/api/recipes/get_recipes_data.yaml
 type_spec/external/api/recipes/set_recipe_inputs.yaml
+type_spec/external/api/recipes/set_recipe_metadata.yaml
 type_spec/external/api/recipes/set_recipe_outputs.yaml
 uncountable/__init__.py
 uncountable/py.typed
@@ -90,18 +117,22 @@ uncountable/integration/db/connect.py
 uncountable/integration/executors/__init__.py
 uncountable/integration/executors/script_executor.py
 uncountable/types/__init__.py
+uncountable/types/async_batch.py
 uncountable/types/base.py
 uncountable/types/calculations.py
+uncountable/types/chemical_structure.py
 uncountable/types/client_base.py
 uncountable/types/curves.py
 uncountable/types/entity.py
 uncountable/types/experiment_groups.py
 uncountable/types/field_values.py
 uncountable/types/fields.py
+uncountable/types/identifier.py
 uncountable/types/input_attributes.py
 uncountable/types/inputs.py
 uncountable/types/outputs.py
 uncountable/types/phases.py
+uncountable/types/recipe_identifiers.py
 uncountable/types/recipe_links.py
 uncountable/types/recipe_metadata.py
 uncountable/types/recipe_output_metadata.py
@@ -113,6 +144,8 @@ uncountable/types/workflows.py
 uncountable/types/api/__init__.py
 uncountable/types/api/batch/__init__.py
 uncountable/types/api/batch/execute_batch.py
+uncountable/types/api/chemical/__init__.py
+uncountable/types/api/chemical/convert_chemical_formats.py
 uncountable/types/api/entity/__init__.py
 uncountable/types/api/entity/create_entities.py
 uncountable/types/api/entity/create_entity.py
@@ -135,9 +168,14 @@ uncountable/types/api/outputs/resolve_output_conditions.py
 uncountable/types/api/project/__init__.py
 uncountable/types/api/project/get_projects.py
 uncountable/types/api/project/get_projects_data.py
+uncountable/types/api/recipe_links/__init__.py
+uncountable/types/api/recipe_links/create_recipe_link.py
 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/associate_recipe_as_input.py
+uncountable/types/api/recipes/associate_recipe_as_lot.py
+uncountable/types/api/recipes/create_recipe.py
 uncountable/types/api/recipes/create_recipes.py
 uncountable/types/api/recipes/get_curve.py
 uncountable/types/api/recipes/get_recipe_calculations.py
@@ -146,4 +184,5 @@ uncountable/types/api/recipes/get_recipe_names.py
 uncountable/types/api/recipes/get_recipe_output_metadata.py
 uncountable/types/api/recipes/get_recipes_data.py
 uncountable/types/api/recipes/set_recipe_inputs.py
+uncountable/types/api/recipes/set_recipe_metadata.py
 uncountable/types/api/recipes/set_recipe_outputs.py

{UncountablePythonSDK-0.0.15 → uncountablepythonsdk-0.0.17}/UncountablePythonSDK.egg-info/top_level.txt

@@ -1,4 +1,5 @@
 dist
+docs
 examples
 pkgs
 type_spec

uncountablepythonsdk-0.0.17/docs/.gitignore

@@ -0,0 +1 @@
+_build

uncountablepythonsdk-0.0.17/docs/conf.py

@@ -0,0 +1,52 @@
+# 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
+
+from datetime import date
+import uncountable
+
+project = "Uncountable SDK"
+copyright = f"{date.today().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"]
+
+autoapi_dirs = ["../uncountable"]
+autoapi_options = [ 'members', 'undoc-members', 'show-inheritance', 'show-module-summary', 'imported-members' ]
+autoapi_ignore = ['*integration*']
+autodoc_typehints = 'description'
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- 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",
+]

uncountablepythonsdk-0.0.17/docs/index.md

@@ -0,0 +1,13 @@
+# Uncountable Python SDK
+
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/UncountablePythonSDK)
+
+
+`Uncountable Python SDK` is a python package that allows interacting with the uncountable platform
+
+```{toctree}
+:maxdepth: 2
+
+quickstart
+```
+

uncountablepythonsdk-0.0.17/docs/justfile

@@ -0,0 +1,12 @@
+docs-setup-python:
+  pip install -r requirements.txt
+
+docs-clean:
+  rm -rf _build/
+
+docs-build: docs-clean
+  PYTHONPATH="$PWD/.." sphinx-build -M dirhtml . _build
+
+docs-serve: docs-build
+  npx serve _build/dirhtml
+

uncountablepythonsdk-0.0.17/docs/quickstart.md

@@ -0,0 +1,19 @@
+# Quickstart
+
+## Installation
+
+Install from PyPI:
+
+```{code-block} bash
+pip install UncountablePythonSDK
+```
+
+## Available SDK methods
+See the following class for a reference for the available python sdk methods. Then see the example in the next section on how to setup and call these methods.
+[](uncountable.types.client_base.ClientMethods)
+
+## Run a simple example
+
+```{literalinclude} ../examples/create_entity.py
+```
+

uncountablepythonsdk-0.0.17/docs/requirements.txt

@@ -0,0 +1,7 @@
+furo==2024.1.29
+myst-parser==2.0.0
+sphinx-autoapi==3.0.0
+sphinx-copybutton==0.5.2
+Sphinx==7.2.6
+sphinx_design==0.5.0
+sphinx-favicon==1.0.1

uncountablepythonsdk-0.0.17/docs/static/favicons/browserconfig.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square150x150logo src="/static/img/icons/mstile-150x150.png"/>
+            <TileColor>#da532c</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>

uncountablepythonsdk-0.0.17/docs/static/favicons/manifest.json

@@ -0,0 +1,18 @@
+{
+    "name": "",
+    "icons": [
+        {
+            "src": "/static/img/icons/android-chrome-192x192.png",
+            "sizes": "192x192",
+            "type": "image/png"
+        },
+        {
+            "src": "/static/img/icons/android-chrome-512x512.png",
+            "sizes": "512x512",
+            "type": "image/png"
+        }
+    ],
+    "theme_color": "#ffffff",
+    "background_color": "#ffffff",
+    "display": "standalone"
+}

uncountablepythonsdk-0.0.17/docs/static/favicons/safari-pinned-tab.svg

@@ -0,0 +1,32 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="16.000000pt" height="16.000000pt" viewBox="0 0 16.000000 16.000000"
+ preserveAspectRatio="xMidYMid meet">
+<metadata>
+Created by potrace 1.11, written by Peter Selinger 2001-2013
+</metadata>
+<g transform="translate(0.000000,16.000000) scale(0.002312,-0.002312)"
+fill="#000000" stroke="none">
+<path d="M3425 6902 c-16 -10 -50 -30 -75 -44 -25 -14 -85 -49 -135 -78 -49
+-29 -110 -64 -135 -78 -25 -13 -70 -39 -100 -57 -119 -71 -800 -463 -875 -505
+-22 -12 -80 -46 -130 -75 -74 -43 -876 -506 -980 -565 -27 -15 -194 -112 -445
+-257 l-85 -49 0 -1733 c0 -1723 0 -1734 20 -1745 11 -6 23 -15 26 -19 3 -5 8
+-7 10 -6 2 2 15 -4 29 -13 14 -9 117 -69 230 -133 113 -65 219 -126 235 -135
+17 -10 59 -34 95 -55 36 -21 77 -45 92 -54 16 -9 187 -107 380 -219 194 -112
+360 -208 368 -213 8 -5 60 -35 115 -66 55 -31 143 -81 195 -111 93 -54 165
+-96 239 -138 20 -11 52 -30 71 -41 19 -11 170 -98 335 -193 165 -95 317 -184
+337 -197 21 -12 40 -23 42 -23 3 0 29 -14 58 -31 29 -18 68 -40 85 -50 l33
+-18 57 31 c32 17 65 37 74 44 8 8 18 14 22 14 4 0 51 26 104 58 54 32 105 61
+113 65 8 4 33 18 55 31 22 14 56 33 75 44 19 11 123 70 230 132 227 132 219
+127 378 219 68 39 128 71 132 71 5 0 10 4 12 8 2 4 30 23 63 41 71 40 113 64
+158 90 88 51 426 246 457 263 68 39 176 101 230 133 30 18 163 94 295 170 132
+76 308 178 390 225 l150 87 0 1733 0 1733 -80 48 c-44 27 -86 48 -92 49 -7 0
+-13 5 -13 10 0 6 -4 10 -9 10 -5 0 -67 34 -136 75 -70 41 -128 75 -130 75 -2
+0 -95 53 -207 118 -111 65 -223 130 -248 144 -48 27 -60 34 -369 212 -112 65
+-218 126 -235 136 -160 91 -474 272 -486 280 -8 5 -42 24 -75 43 -33 19 -76
+43 -95 55 -180 104 -472 271 -502 287 -21 11 -38 23 -38 27 0 5 -4 8 -8 8 -5
+0 -68 34 -140 75 -72 41 -133 75 -134 75 -2 0 -16 -8 -33 -18z"/>
+</g>
+</svg>

uncountablepythonsdk-0.0.17/examples/create_entity.py

@@ -0,0 +1,25 @@
+from uncountable.core import AuthDetailsApiKey, Client
+from uncountable.types import (
+    entity_t,
+    field_values_t,
+)
+
+
+client = Client(
+    base_url="https://app.uncountable.com",
+    auth_details=AuthDetailsApiKey(
+        api_id="X",
+        api_secret_key="X",
+    ),
+)
+entities = client.create_entity(
+    definition_id=24,
+    entity_type=entity_t.EntityType.LAB_REQUEST,
+    field_values=[
+        field_values_t.FieldRefNameValue(
+            field_ref_name="name", value="SDK Lab Request"
+        ),
+        field_values_t.FieldRefNameValue(field_ref_name="materialFamilyId", value=1),
+    ],
+)
+print(entities)

{UncountablePythonSDK-0.0.15 → uncountablepythonsdk-0.0.17}/pkgs/argument_parser/argument_parser.py

@@ -43,9 +43,7 @@ def is_missing(field_type: typing.Any) -> bool:
     if origin is not typing.Union:
         return False
     args = typing.get_args(field_type)
-    if len(args) == 0 or args[0] is not MissingSentryType:
-        return False
-    return True
+    return not (len(args) == 0 or args[0] is not MissingSentryType)
 
 
 def _invoke_tuple_parsers(
@@ -72,14 +70,17 @@ def _invoke_fallback_parsers(
     arg_parsers: typing.Sequence[typing.Callable[[typing.Any], T]],
     value: typing.Any,
 ) -> T:
+    exceptions = []
+
     for parser in arg_parsers:
         try:
             return parser(value)
-        except Exception:
+        except Exception as e:
+            exceptions.append(e)
             continue
     raise ValueError(
         f"Unhandled value {value} cannot be cast to a member of {original_type}"
-    )
+    ) from ExceptionGroup("Fallback Parser Exception", exceptions)
 
 
 def _invoke_membership_parser(
@@ -173,10 +174,16 @@ def _build_parser_inner(
             raise ValueError("List types only support one argument")
         arg_parser = _build_parser_inner(args[0], context)
 
+        def parse_element(value: typing.Any) -> typing.Any:
+            try:
+                return arg_parser(value)
+            except Exception as e:
+                raise ValueError("Failed to parse element", value) from e
+
         def parse(value: typing.Any) -> typing.Any:
             if not isinstance(value, list):
                 raise ValueError("value is not a list", parsed_type)
-            return origin(arg_parser(x) for x in value)
+            return origin(parse_element(x) for x in value)
 
         return parse
 

uncountablepythonsdk-0.0.17/pkgs/type_spec/actions_registry/__main__.py

@@ -0,0 +1,108 @@
+"""
+This processes the directory main/unc/materials/shared/actions_registry and emits actions_registry/action_definitions.tsx
+"""
+
+import os
+import sys
+from collections import defaultdict
+from dataclasses import dataclass
+from typing import TypeVar
+
+from main.base.types import actions_registry_t
+from pkgs.type_spec import builder
+
+from ...argument_parser import CachedParser
+from ..emit_typescript_util import ts_name
+from ..util import rewrite_file
+from .emit_typescript import emit_action_definitions
+
+key_name = "name"
+key_icon = "icon"
+key_short_description = "short_description"
+key_description = "description"
+
+
+TypeT = TypeVar("TypeT")
+
+
+class InvalidSpecException(Exception):
+    pass
+
+
+@dataclass(kw_only=True)
+class ActionRegistryFileInfo:
+    directories: list[str]
+    filename: str
+    filepath: str
+
+
+ACTIONS_REGISTRY_ROOT = "main/unc/materials/shared/actions_registry/"
+action_definition_parser = CachedParser(
+    dict[str, actions_registry_t.ActionDefinitionYaml]
+)
+
+
+def get_action_registry_files_info() -> list[ActionRegistryFileInfo]:
+    files_info = []
+    for dirname, _, files in os.walk(ACTIONS_REGISTRY_ROOT):
+        directories = dirname.replace(ACTIONS_REGISTRY_ROOT, "").split("/")
+        for filename in files:
+            filepath = os.path.join(dirname, filename)
+            if os.path.isfile(filepath) and filepath.endswith(".yaml"):
+                files_info.append(
+                    ActionRegistryFileInfo(
+                        directories=directories,
+                        filename=filename.replace(".yaml", ""),
+                        filepath=filepath,
+                    )
+                )
+    return files_info
+
+
+def main() -> None:
+    files_info = get_action_registry_files_info()
+    action_definitions: defaultdict[str, list[actions_registry_t.ActionDefinition]] = (
+        defaultdict(list)
+    )
+    for file_info in files_info:
+        in_action_definitions = action_definition_parser.parse_yaml_file(
+            file_info.filepath
+        )
+        if len(in_action_definitions) == 0:
+            continue
+
+        for ref_name, definition in in_action_definitions.items():
+            modules = [*file_info.directories]
+            # if the actions are stored in index.yaml, parent dir should be treated as module
+            if file_info.filename != "index":
+                modules.append(file_info.filename)
+
+            module_str = "_".join(modules)
+            action_definitions[module_str].append(
+                actions_registry_t.ActionDefinition(
+                    name=definition.name,
+                    short_description=definition.short_description,
+                    description=definition.description,
+                    icon=definition.icon,
+                    ref_name=ref_name,
+                    module=actions_registry_t.ActionsRegistryModule(
+                        ts_name(module_str, name_case=builder.NameCase.convert)
+                    ),
+                    visibility_scope=[
+                        actions_registry_t.ActionDefinitionVisibilityScope(item)
+                        for item in definition.visibility_scope
+                    ]
+                    if definition.visibility_scope is not None
+                    else None,
+                )
+            )
+
+    ts_content = emit_action_definitions(action_definitions)
+    rewrite_file(
+        "main/site/js/materials/base/actions_registry/action_definitions.tsx",
+        ts_content,
+    )
+    sys.exit(0)
+
+
+main()