aignostics 0.2.16__tar.gz → 0.2.199__tar.gz

{aignostics-0.2.16 → aignostics-0.2.199}/.gitignore

@@ -76,6 +76,7 @@ node_modules/
 
 # AI workflow
 .fixme
+CLAUDE.local.md
 
 # Copier
 *.rej
@@ -94,5 +95,6 @@ data/**
 dist_vercel
 setup.sh.secret
 __marimo__
+dist_native/**
+!dist_native/.keep
 notes.md
-CLAUDE.md

{aignostics-0.2.16 → aignostics-0.2.199}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aignostics
-Version: 0.2.16
+Version: 0.2.199
 Summary: 🔬 Python SDK providing access to the Aignostics Platform. Includes Aignostics Launchpad (Desktop Application), Aignostics CLI (Command-Line Interface), example notebooks, and Aignostics Client Library.
 Project-URL: Homepage, https://aignostics.readthedocs.io/en/latest/
 Project-URL: Documentation, https://aignostics.readthedocs.io/en/latest/
@@ -47,71 +47,72 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
-Requires-Python: <4.0,>=3.11
-Requires-Dist: appdirs>=1.4.4
-Requires-Dist: boto3>=1.38.22
-Requires-Dist: click
-Requires-Dist: dicom-validator>=0.6.2
-Requires-Dist: dicomweb-client[gcp]>=0.59.3
-Requires-Dist: duckdb<=1.2.1,>=0.10.0
-Requires-Dist: fastapi[all,standard]>=0.115.12
-Requires-Dist: google-cloud-storage>=3.1.0
-Requires-Dist: google-crc32c>=1.7.1
-Requires-Dist: highdicom>=0.25.1
-Requires-Dist: httpx>=0.28.1
-Requires-Dist: humanize>=4.12.3
-Requires-Dist: idc-index-data==21.0.0
-Requires-Dist: jsf>=0.11.2
-Requires-Dist: jsonschema>=4.23.0
-Requires-Dist: logfire[system-metrics]>=3.16.0
-Requires-Dist: nicegui[native]>=2.17.0
-Requires-Dist: openslide-bin>=4.0.0.8
-Requires-Dist: openslide-python>=1.4.2
-Requires-Dist: opentelemetry-instrumentation-fastapi>=0.53b0
-Requires-Dist: opentelemetry-instrumentation-httpx>=0.53b0
-Requires-Dist: opentelemetry-instrumentation-jinja2>=0.53b0
-Requires-Dist: opentelemetry-instrumentation-requests>=0.53b0
-Requires-Dist: opentelemetry-instrumentation-sqlite3>=0.53b0
-Requires-Dist: opentelemetry-instrumentation-tornado>=0.53b0
-Requires-Dist: opentelemetry-instrumentation-urllib3>=0.53b0
-Requires-Dist: opentelemetry-instrumentation-urllib>=0.53b0
-Requires-Dist: packaging
-Requires-Dist: pandas<=2.2.4
-Requires-Dist: platformdirs
-Requires-Dist: psutil
-Requires-Dist: psutil>=7.0.0
-Requires-Dist: pyarrow
-Requires-Dist: pydantic-settings>=2.9.1
-Requires-Dist: pyjwt[crypto]>=2.10.1
-Requires-Dist: python-dateutil>=2.9.0.post0
-Requires-Dist: pywin32>=310; sys_platform == 'win32'
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: requests
-Requires-Dist: requests-oauthlib>=2.0.0
-Requires-Dist: requests>=2.32.3
-Requires-Dist: s5cmd
-Requires-Dist: s5cmd>=0.2.0
-Requires-Dist: sentry-sdk>=2.29.1
-Requires-Dist: shapely>=2.1.1
-Requires-Dist: show-in-file-manager>=1.1.5
-Requires-Dist: sphinx-click
-Requires-Dist: tqdm
-Requires-Dist: tqdm>=4.67.1
-Requires-Dist: typer>=0.15.4
-Requires-Dist: uptime>=3.0.1
-Requires-Dist: urllib3>=2.2.3
-Requires-Dist: wsidicom>=0.27.1
+Requires-Python: <3.14,>=3.11
+Requires-Dist: aiopath<1,>=0.6.11
+Requires-Dist: boto3<2,>=1.40.64
+Requires-Dist: certifi<2026,>=2025.10.5
+Requires-Dist: defusedxml>=0.7.1
+Requires-Dist: dicom-validator<1,>=0.7.3
+Requires-Dist: dicomweb-client[gcp]<1,>=0.59.3
+Requires-Dist: duckdb<=1.4.1,>=0.10.0
+Requires-Dist: fastapi[all,standard]<1,>=0.120.4
+Requires-Dist: fastparquet<2025,>=2024.11.0
+Requires-Dist: google-cloud-storage<4,>=3.4.1
+Requires-Dist: google-crc32c<2,>=1.7.1
+Requires-Dist: highdicom<1,>=0.26.1
+Requires-Dist: html-sanitizer<3,>=2.6.0
+Requires-Dist: httpx<1,>=0.28.1
+Requires-Dist: humanize<5,>=4.14.0
+Requires-Dist: idc-index-data==22.0.2
+Requires-Dist: ijson<4,>=3.4.0.post0
+Requires-Dist: jsf<1,>=0.11.2
+Requires-Dist: jsonschema[format-nongpl]<5,>=4.25.1
+Requires-Dist: logfire[system-metrics]<5,>=4.14.2
+Requires-Dist: nicegui[native]<3.2.0,>=3.1.0
+Requires-Dist: openslide-bin<5,>=4.0.0.8
+Requires-Dist: openslide-python<2,>=1.4.2
+Requires-Dist: opentelemetry-instrumentation-fastapi<1,>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-httpx<1,>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-jinja2<1,>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-requests<1,>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-sqlite3<1,>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-tornado<1,>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-urllib3<1,>=0.53b0
+Requires-Dist: opentelemetry-instrumentation-urllib<1,>=0.53b0
+Requires-Dist: packaging<26,>=25.0
+Requires-Dist: pandas<3,>=2.3.3
+Requires-Dist: platformdirs<5,>=4.3.8
+Requires-Dist: platformdirs<5,>=4.5.0
+Requires-Dist: psutil<8,>=7.1.2
+Requires-Dist: pydantic-settings<3,>=2.11.0
+Requires-Dist: pyjwt[crypto]<3,>=2.10.1
+Requires-Dist: python-dateutil<3,>=2.9.0.post0
+Requires-Dist: pywin32<311,>=310; sys_platform == 'win32'
+Requires-Dist: pyyaml<7,>=6.0.3
+Requires-Dist: requests-oauthlib<3,>=2.0.0
+Requires-Dist: requests<3,>=2.32.5
+Requires-Dist: s5cmd<1,>=0.3.3
+Requires-Dist: semver<4,>=3.0.4
+Requires-Dist: sentry-sdk<3,>=2.43.0
+Requires-Dist: shapely<3,>=2.1.2
+Requires-Dist: tenacity<10,>=9.1.2
+Requires-Dist: tqdm<5,>=4.67.1
+Requires-Dist: truststore<1,>=0.10.4
+Requires-Dist: typer<1,>=0.20.0
+Requires-Dist: uptime<4,>=3.0.1
+Requires-Dist: urllib3<3,>=2.5.0
+Requires-Dist: wsidicom<1,>=0.28.1
 Provides-Extra: jupyter
-Requires-Dist: jupyter>=1.1.1; extra == 'jupyter'
+Requires-Dist: jupyter<2,>=1.1.1; extra == 'jupyter'
 Provides-Extra: marimo
-Requires-Dist: cloudpathlib>=0.21.1; extra == 'marimo'
-Requires-Dist: marimo>=0.13.11; extra == 'marimo'
-Requires-Dist: matplotlib>=3.10.3; extra == 'marimo'
-Requires-Dist: shapely>=2.1.0; extra == 'marimo'
+Requires-Dist: cloudpathlib<1,>=0.23.0; extra == 'marimo'
+Requires-Dist: ipython<10,>=9.6.0; extra == 'marimo'
+Requires-Dist: marimo<1,>=0.17.2; extra == 'marimo'
+Requires-Dist: matplotlib<4,>=3.10.7; extra == 'marimo'
+Requires-Dist: shapely<3,>=2.1.0; extra == 'marimo'
+Provides-Extra: pyinstaller
+Requires-Dist: pyinstaller<7,>=6.14.0; extra == 'pyinstaller'
 Provides-Extra: qupath
-Requires-Dist: geopandas>=1.0.1; extra == 'qupath'
-Requires-Dist: ijson>=3.3.0; extra == 'qupath'
-Requires-Dist: paquo>=0.8.1; extra == 'qupath'
 Description-Content-Type: text/markdown
 
 
@@ -141,7 +142,7 @@ Description-Content-Type: text/markdown
 The **Aignostics Python SDK** includes multiple pathways to interact with the
 **Aignostics Platform**:
 
-1. Use the **Aignostics Launchpad** to analyze whole slide images with advanced computational pathology applications like 
+1. Use the **Aignostics Launchpad** to analyze whole slide images with advanced computational pathology applications like
    [Atlas H&E-TME](https://www.aignostics.com/products/he-tme-profiling-product) directly from your desktop.
    View your results by launching popular tools such as [QuPath](https://qupath.github.io/) and Python Notebooks with one click.
    The app runs on Mac OS X, Windows, and Linux.
@@ -176,28 +177,34 @@ more about how we achieve
 ## Quick Start
 
 > [!Note]
-> See as follows for a quick start guide to get you up and running with the Aignostics Python SDK as quickly as possible. 
-> If you first want to learn bout the basic concepts and components of the Aignostics Platform skip to that section below. 
-> The further reading section points you to reference documentation listing all available CLI commands, methods and classes provided by the client library, operations of the API, how we achieve operational excellence, security, and more. 
+> See as follows for a quick start guide to get you up and running with the Aignostics Python SDK as quickly as possible.
+> If you first want to learn bout the basic concepts and components of the Aignostics Platform skip to that section below.
+> The further reading section points you to reference documentation listing all available CLI commands, methods and classes provided by the client library, operations of the API, how we achieve operational excellence, security, and more.
 > If you are not familiar with terminology please check the glossary at the end of this document.
 
 ### Launchpad: Run your first computational pathology analysis in 10 minutes from your desktop
 
 The **Aignostics Launchpad** is a graphical desktop application that allows you to run
-applications on whole slide images (WSIs) from your computer, and inspect results with QuPath and Python Notebooks with one click. It is designed to be user-friendly and intuitive, for use by Research Pathologists and Data Scientists. 
+applications on whole slide images (WSIs) from your computer, and inspect results with QuPath and Python Notebooks with one click. It is designed to be user-friendly and intuitive, for use by Research Pathologists and Data Scientists.
 
 The Launchpad is available for Mac OS X, Windows, and Linux, and can be installed easily:
 
-1. Visit the [Quick Start](https://platform.aignostics.com/getting-started/quick-start) 
+1. Visit the [Quick Start](https://platform.aignostics.com/getting-started/quick-start)
    page in the Aignostics Console.
 2. Copy the installation script and paste it into your terminal - compatible with MacOS, Windows, and Linux.
 3. Launch the application by running `uvx aignostics launchpad`.
-4. Follow the intuitive graphical interface to analyze public datasets or your own whole slide images 
+4. Follow the intuitive graphical interface to analyze public datasets or your own whole slide images
    with [Atlas H&E-TME](https://www.aignostics.com/products/he-tme-profiling-product) and other computational pathology applications.
 
+> [!Note]
+> The Launchpad features a growing ecosystem of extensions that seamlessly integrate with standard digital pathology tools. To use the Launchpad with all available extensions, run `uvx --from "aignostics[qupath,marimo]" aignostics launchpad`. Currently available extensions are:
+>
+> 1. **QuPath extension**: View your application results in [QuPath](https://qupath.github.io/) with a single click. The Launchpad creates QuPath projects on-the-fly.
+> 2. **Marimo extension**: Analyze your application results using [Marimo](https://marimo.io/) notebooks embedded in the Launchpad. You don't have to leave the Launchpad to do real data science.
+
 ### CLI: Manage datasets and application runs from your terminal
 
-The Python SDK includes the **Aignostics CLI**, a Command-Line Interface that allows you to
+The Python SDK includes the **Aignostics CLI**, a Command-Line Interface (CLI) that allows you to
 interact with the Aignostics Platform directly from your terminal or shell script.
 
 See as follows for a simple example where we download a sample dataset for the [Atlas
@@ -218,7 +225,7 @@ nano tcga_luad/metadata.csv
 uvx aignostics application run upload he-tme data/tcga_luad/run.csv
 # Submit the application run and print tha run id
 uvx aignostics application run submit he-tme data/tcga_luad/run.csv
-# Check the status of the application run you triggered
+# Check the status of the application run you submitted
 uvx aignostics application run list
 # Incrementally download results when they become available
 # Fill in the id from the output in the previous step
@@ -255,10 +262,10 @@ to learn about all commands and options available.
 > [your personal dashboard on the Aignostics Platform website](https://platform.aignostics.com/getting-started/quick-start)
 > and follow the steps outlined in the `Use in Python Notebooks` section.
 
-The Python SDK includes Jupyter and Marimo notebooks to help you get started interacting 
+The Python SDK includes Jupyter and Marimo notebooks to help you get started interacting
 with the Aignostics Platform in your notebook environment.
 
-The notebooks showcase the interaction with the Aignostics Platform using our "Test Application". To run one them, 
+The notebooks showcase the interaction with the Aignostics Platform using our "Test Application". To run one them,
 please follow the steps outlined in the snippet below to clone this repository and start either the
 [Jupyter](https://docs.jupyter.org/en/latest/index.html)
 ([examples/notebook.ipynb](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.ipynb))
@@ -292,12 +299,12 @@ uv run marimo edit examples/notebook.py
 Next to using the Launchpad, CLI and example notebooks, the Python SDK includes the
 *Aignostics Client Library* for integration with your Python Codebase.
 
-The following sections outline how to install the Python SDK for this purpose and 
+The following sections outline how to install the Python SDK for this purpose and
 interact with the Client.
 
 ### Installation
 
-The Aignostics Python SDK is published on the [Python Package Index (PyPI)](https://pypi.org/project/aignostics/), 
+The Aignostics Python SDK is published on the [Python Package Index (PyPI)](https://pypi.org/project/aignostics/),
 is compatible with Python 3.11 and above, and can be installed via via `uv` or `pip`:
 
 **Install with [uv](https://docs.astral.sh/uv/):** If you don't have uv
@@ -317,7 +324,7 @@ pip install aignostics
 
 #### Usage
 
-The following snippet shows how to use the Client to trigger an application
+The following snippet shows how to use the Client to submit an application
 run:
 
 ```python
@@ -325,21 +332,21 @@ from aignostics import platform
 
 # initialize the client
 client = platform.Client()
-# trigger an application run
-application_run = client.runs.create(
-   application_version="two-task-dummy:v0.35.0",
+# submit an application run
+application_run = client.runs.submit(
+   application_id="test-app",
    items=[
       platform.InputItem(
-         reference="slide-1",
+         external_id="slide-1",
          input_artifacts=[
             platform.InputArtifact(
-               name="user_slide",
+               name="whole_slide_image",
                download_url="<a signed url to download the data>",
                metadata={
-                  "checksum_crc32c": "AAAAAA==",
-                  "base_mpp": 0.25,
-                  "width": 1000,
-                  "height": 1000,
+                  "checksum_base64_crc32c": "AAAAAA==",
+                  "resolution_mpp": 0.25,
+                  "width_px": 1000,
+                  "height_px": 1000,
                },
             )
          ],
@@ -357,22 +364,23 @@ to learn about all classes and methods.
 
 ##### Defining the input for an application run
 
-Next to the `application_version` of the application you want to run, you have
-to define the input items you want to process in the run. The input items are
-defined as follows:
+When creating an application run, you need to specify the `application_id` and optionally the
+`application_version` (version number) of the application you want to run. If you omit the version,
+the latest version will be used automatically. Additionally, you need to define the input items you
+want to process in the run. The input items are defined as follows:
 
 ```python
 platform.InputItem(
-    reference="1",
+    external_id="1",
     input_artifacts=[
         platform.InputArtifact(
-            name="user_slide", # defined by the application version input_artifact schema
+            name="whole_slide_image", # defined by the application version's input artifact schema
             download_url="<a signed url to download the data>",
-            metadata={ # defined by the application version input_artifact schema
-                "checksum_crc32c": "N+LWCg==",
-                "base_mpp": 0.46499982,
-                "width": 3728,
-                "height": 3640,
+            metadata={ # defined by the application version's input artifact schema
+                "checksum_base64_crc32c": "N+LWCg==",
+                "resolution_mpp": 0.46499982,
+                "width_px": 3728,
+                "height_px": 3640,
             },
         )
     ],
@@ -385,7 +393,7 @@ string. This is used to identify the item in the results later on. The
 data & metadata you need to provide for each item. The required artifacts depend
 on the application version you want to run - in the case of test application,
 there is only one artifact required, which is the image to process on. The
-artifact name is defined as `user_slide`.
+artifact name is defined as `whole_slide_image` for this application.
 
 The `download_url` is a signed URL that allows the Aignostics Platform to
 download the image data later during processing.
@@ -526,7 +534,8 @@ Every WSI processed by the Platform generates a cost. Usage of the "Test Applica
    with detailed documentation of public classes and functions.
 4. Check out the
    [API reference](https://aignostics.readthedocs.io/en/latest/api_reference_v1.html)
-   with detailed documentation of all API operations and parameters.
+   with detailed documentation of all API operations and parameters. See as well
+   the OpenAPI Specification in [JSON](https://github.com/aignostics/python-sdk/blob/main/docs/source/_static/openapi_v1.json) and [YAML](https://github.com/aignostics/python-sdk/blob/main/docs/source/_static/openapi_v1.yaml), and the [API Explorer](https://aignostics.readthedocs.io/en/latest/api_explorer_v1.html).
 5. Our
    [release notes](https://aignostics.readthedocs.io/en/latest/release-notes.html)
    provide a complete log of recent improvements and changes.

{aignostics-0.2.16 → aignostics-0.2.199}/README.md

@@ -25,7 +25,7 @@
 The **Aignostics Python SDK** includes multiple pathways to interact with the
 **Aignostics Platform**:
 
-1. Use the **Aignostics Launchpad** to analyze whole slide images with advanced computational pathology applications like 
+1. Use the **Aignostics Launchpad** to analyze whole slide images with advanced computational pathology applications like
    [Atlas H&E-TME](https://www.aignostics.com/products/he-tme-profiling-product) directly from your desktop.
    View your results by launching popular tools such as [QuPath](https://qupath.github.io/) and Python Notebooks with one click.
    The app runs on Mac OS X, Windows, and Linux.
@@ -60,28 +60,34 @@ more about how we achieve
 ## Quick Start
 
 > [!Note]
-> See as follows for a quick start guide to get you up and running with the Aignostics Python SDK as quickly as possible. 
-> If you first want to learn bout the basic concepts and components of the Aignostics Platform skip to that section below. 
-> The further reading section points you to reference documentation listing all available CLI commands, methods and classes provided by the client library, operations of the API, how we achieve operational excellence, security, and more. 
+> See as follows for a quick start guide to get you up and running with the Aignostics Python SDK as quickly as possible.
+> If you first want to learn bout the basic concepts and components of the Aignostics Platform skip to that section below.
+> The further reading section points you to reference documentation listing all available CLI commands, methods and classes provided by the client library, operations of the API, how we achieve operational excellence, security, and more.
 > If you are not familiar with terminology please check the glossary at the end of this document.
 
 ### Launchpad: Run your first computational pathology analysis in 10 minutes from your desktop
 
 The **Aignostics Launchpad** is a graphical desktop application that allows you to run
-applications on whole slide images (WSIs) from your computer, and inspect results with QuPath and Python Notebooks with one click. It is designed to be user-friendly and intuitive, for use by Research Pathologists and Data Scientists. 
+applications on whole slide images (WSIs) from your computer, and inspect results with QuPath and Python Notebooks with one click. It is designed to be user-friendly and intuitive, for use by Research Pathologists and Data Scientists.
 
 The Launchpad is available for Mac OS X, Windows, and Linux, and can be installed easily:
 
-1. Visit the [Quick Start](https://platform.aignostics.com/getting-started/quick-start) 
+1. Visit the [Quick Start](https://platform.aignostics.com/getting-started/quick-start)
    page in the Aignostics Console.
 2. Copy the installation script and paste it into your terminal - compatible with MacOS, Windows, and Linux.
 3. Launch the application by running `uvx aignostics launchpad`.
-4. Follow the intuitive graphical interface to analyze public datasets or your own whole slide images 
+4. Follow the intuitive graphical interface to analyze public datasets or your own whole slide images
    with [Atlas H&E-TME](https://www.aignostics.com/products/he-tme-profiling-product) and other computational pathology applications.
 
+> [!Note]
+> The Launchpad features a growing ecosystem of extensions that seamlessly integrate with standard digital pathology tools. To use the Launchpad with all available extensions, run `uvx --from "aignostics[qupath,marimo]" aignostics launchpad`. Currently available extensions are:
+>
+> 1. **QuPath extension**: View your application results in [QuPath](https://qupath.github.io/) with a single click. The Launchpad creates QuPath projects on-the-fly.
+> 2. **Marimo extension**: Analyze your application results using [Marimo](https://marimo.io/) notebooks embedded in the Launchpad. You don't have to leave the Launchpad to do real data science.
+
 ### CLI: Manage datasets and application runs from your terminal
 
-The Python SDK includes the **Aignostics CLI**, a Command-Line Interface that allows you to
+The Python SDK includes the **Aignostics CLI**, a Command-Line Interface (CLI) that allows you to
 interact with the Aignostics Platform directly from your terminal or shell script.
 
 See as follows for a simple example where we download a sample dataset for the [Atlas
@@ -102,7 +108,7 @@ nano tcga_luad/metadata.csv
 uvx aignostics application run upload he-tme data/tcga_luad/run.csv
 # Submit the application run and print tha run id
 uvx aignostics application run submit he-tme data/tcga_luad/run.csv
-# Check the status of the application run you triggered
+# Check the status of the application run you submitted
 uvx aignostics application run list
 # Incrementally download results when they become available
 # Fill in the id from the output in the previous step
@@ -139,10 +145,10 @@ to learn about all commands and options available.
 > [your personal dashboard on the Aignostics Platform website](https://platform.aignostics.com/getting-started/quick-start)
 > and follow the steps outlined in the `Use in Python Notebooks` section.
 
-The Python SDK includes Jupyter and Marimo notebooks to help you get started interacting 
+The Python SDK includes Jupyter and Marimo notebooks to help you get started interacting
 with the Aignostics Platform in your notebook environment.
 
-The notebooks showcase the interaction with the Aignostics Platform using our "Test Application". To run one them, 
+The notebooks showcase the interaction with the Aignostics Platform using our "Test Application". To run one them,
 please follow the steps outlined in the snippet below to clone this repository and start either the
 [Jupyter](https://docs.jupyter.org/en/latest/index.html)
 ([examples/notebook.ipynb](https://github.com/aignostics/python-sdk/blob/main/examples/notebook.ipynb))
@@ -176,12 +182,12 @@ uv run marimo edit examples/notebook.py
 Next to using the Launchpad, CLI and example notebooks, the Python SDK includes the
 *Aignostics Client Library* for integration with your Python Codebase.
 
-The following sections outline how to install the Python SDK for this purpose and 
+The following sections outline how to install the Python SDK for this purpose and
 interact with the Client.
 
 ### Installation
 
-The Aignostics Python SDK is published on the [Python Package Index (PyPI)](https://pypi.org/project/aignostics/), 
+The Aignostics Python SDK is published on the [Python Package Index (PyPI)](https://pypi.org/project/aignostics/),
 is compatible with Python 3.11 and above, and can be installed via via `uv` or `pip`:
 
 **Install with [uv](https://docs.astral.sh/uv/):** If you don't have uv
@@ -201,7 +207,7 @@ pip install aignostics
 
 #### Usage
 
-The following snippet shows how to use the Client to trigger an application
+The following snippet shows how to use the Client to submit an application
 run:
 
 ```python
@@ -209,21 +215,21 @@ from aignostics import platform
 
 # initialize the client
 client = platform.Client()
-# trigger an application run
-application_run = client.runs.create(
-   application_version="two-task-dummy:v0.35.0",
+# submit an application run
+application_run = client.runs.submit(
+   application_id="test-app",
    items=[
       platform.InputItem(
-         reference="slide-1",
+         external_id="slide-1",
          input_artifacts=[
             platform.InputArtifact(
-               name="user_slide",
+               name="whole_slide_image",
                download_url="<a signed url to download the data>",
                metadata={
-                  "checksum_crc32c": "AAAAAA==",
-                  "base_mpp": 0.25,
-                  "width": 1000,
-                  "height": 1000,
+                  "checksum_base64_crc32c": "AAAAAA==",
+                  "resolution_mpp": 0.25,
+                  "width_px": 1000,
+                  "height_px": 1000,
                },
             )
          ],
@@ -241,22 +247,23 @@ to learn about all classes and methods.
 
 ##### Defining the input for an application run
 
-Next to the `application_version` of the application you want to run, you have
-to define the input items you want to process in the run. The input items are
-defined as follows:
+When creating an application run, you need to specify the `application_id` and optionally the
+`application_version` (version number) of the application you want to run. If you omit the version,
+the latest version will be used automatically. Additionally, you need to define the input items you
+want to process in the run. The input items are defined as follows:
 
 ```python
 platform.InputItem(
-    reference="1",
+    external_id="1",
     input_artifacts=[
         platform.InputArtifact(
-            name="user_slide", # defined by the application version input_artifact schema
+            name="whole_slide_image", # defined by the application version's input artifact schema
             download_url="<a signed url to download the data>",
-            metadata={ # defined by the application version input_artifact schema
-                "checksum_crc32c": "N+LWCg==",
-                "base_mpp": 0.46499982,
-                "width": 3728,
-                "height": 3640,
+            metadata={ # defined by the application version's input artifact schema
+                "checksum_base64_crc32c": "N+LWCg==",
+                "resolution_mpp": 0.46499982,
+                "width_px": 3728,
+                "height_px": 3640,
             },
         )
     ],
@@ -269,7 +276,7 @@ string. This is used to identify the item in the results later on. The
 data & metadata you need to provide for each item. The required artifacts depend
 on the application version you want to run - in the case of test application,
 there is only one artifact required, which is the image to process on. The
-artifact name is defined as `user_slide`.
+artifact name is defined as `whole_slide_image` for this application.
 
 The `download_url` is a signed URL that allows the Aignostics Platform to
 download the image data later during processing.
@@ -410,7 +417,8 @@ Every WSI processed by the Platform generates a cost. Usage of the "Test Applica
    with detailed documentation of public classes and functions.
 4. Check out the
    [API reference](https://aignostics.readthedocs.io/en/latest/api_reference_v1.html)
-   with detailed documentation of all API operations and parameters.
+   with detailed documentation of all API operations and parameters. See as well
+   the OpenAPI Specification in [JSON](https://github.com/aignostics/python-sdk/blob/main/docs/source/_static/openapi_v1.json) and [YAML](https://github.com/aignostics/python-sdk/blob/main/docs/source/_static/openapi_v1.yaml), and the [API Explorer](https://aignostics.readthedocs.io/en/latest/api_explorer_v1.html).
 5. Our
    [release notes](https://aignostics.readthedocs.io/en/latest/release-notes.html)
    provide a complete log of recent improvements and changes.

aignostics-0.2.199/codegen/out/.openapi-generator/FILES

@@ -0,0 +1,39 @@
+aignx/codegen/api/public_api.py
+aignx/codegen/api_client.py
+aignx/codegen/api_response.py
+aignx/codegen/configuration.py
+aignx/codegen/exceptions.py
+aignx/codegen/models/application_read_response.py
+aignx/codegen/models/application_read_short_response.py
+aignx/codegen/models/application_version.py
+aignx/codegen/models/artifact_output.py
+aignx/codegen/models/artifact_state.py
+aignx/codegen/models/artifact_termination_reason.py
+aignx/codegen/models/custom_metadata_update_request.py
+aignx/codegen/models/http_validation_error.py
+aignx/codegen/models/input_artifact.py
+aignx/codegen/models/input_artifact_creation_request.py
+aignx/codegen/models/item_creation_request.py
+aignx/codegen/models/item_output.py
+aignx/codegen/models/item_result_read_response.py
+aignx/codegen/models/item_state.py
+aignx/codegen/models/item_termination_reason.py
+aignx/codegen/models/me_read_response.py
+aignx/codegen/models/organization_read_response.py
+aignx/codegen/models/output_artifact.py
+aignx/codegen/models/output_artifact_result_read_response.py
+aignx/codegen/models/output_artifact_scope.py
+aignx/codegen/models/output_artifact_visibility.py
+aignx/codegen/models/run_creation_request.py
+aignx/codegen/models/run_creation_response.py
+aignx/codegen/models/run_item_statistics.py
+aignx/codegen/models/run_output.py
+aignx/codegen/models/run_read_response.py
+aignx/codegen/models/run_state.py
+aignx/codegen/models/run_termination_reason.py
+aignx/codegen/models/user_read_response.py
+aignx/codegen/models/validation_error.py
+aignx/codegen/models/validation_error_loc_inner.py
+aignx/codegen/models/version_read_response.py
+aignx/codegen/rest.py
+docs/PublicApi.md