aignostics 0.2.2__tar.gz → 0.2.10__tar.gz

{aignostics-0.2.2 → aignostics-0.2.10}/.gitignore

@@ -95,3 +95,4 @@ dist_vercel
 setup.sh.secret
 __marimo__
 notes.md
+CLAUDE.md

{aignostics-0.2.2 → aignostics-0.2.10}/PKG-INFO

@@ -1,14 +1,13 @@
 Metadata-Version: 2.4
 Name: aignostics
-Version: 0.2.2
-Summary: 🔬 Python SDK providing access to Aignostics AI services.
+Version: 0.2.10
+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/
 Project-URL: Source, https://github.com/aignostics/python-sdk
 Project-URL: Changelog, https://github.com/aignostics/python-sdk/releases
 Project-URL: Issues, https://github.com/aignostics/python-sdk/issues
-Author: Andreas Kuhn
-Author-email: Helmut Hoffer von Ankershoffen <helmut@aignostics.com>
+Author-email: Helmut Hoffer von Ankershoffen <helmut@aignostics.com>, Andreas Kunft <andreas@aignostics.com>
 License: MIT License
         
         Copyright (c) [2025] [Aignostics GmbH (support@aignostics.com)]
@@ -137,7 +136,7 @@ Description-Content-Type: text/markdown
 ---
 
 
-## 1) Introduction
+## Introduction
 
 The **Aignostics Python SDK** includes multiple pathways to interact with the
 **Aignostics Platform**:
@@ -174,13 +173,15 @@ more about how we achieve
 [operational excellence](https://aignostics.readthedocs.io/en/latest/operational_excellence.html) and
 [security](https://aignostics.readthedocs.io/en/latest/security.html).
 
-## 2) Quick Start
+## 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, please jump to section 3 below.
+> 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.
 
-### Aignostics Launchpad: Run your first computational pathology analysis in 10 minutes from your desktop
+### 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. 
@@ -194,9 +195,9 @@ The Launchpad is available for Mac OS X, Windows, and Linux, and can be installe
 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.
 
-### Aignostics CLI: Manage datasets and application runs from your terminal
+### CLI: Manage datasets and application runs from your terminal
 
-The Aignostics 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 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
@@ -205,29 +206,41 @@ H&E-TME application](https://www.aignostics.com/products/he-tme-profiling-produc
 ```shell
 # Download a sample dataset from the NCI Image Data Commons (IDC) portal to your current working directory
 # As the dataset id refers to the TCGA LUAD collection, this creates a directory tcga_luad with the DICOM files
-uvx aignostics dataset idc download 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 .
+uvx aignostics dataset idc download 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 data/
 # Prepare the metadata for the application run by creating a metadata.csv, extracting 
 # the required metadata from the DICOM files. We furthermore add the required
 # information about the tissue type and disease. TODO (Helmut): Update
-uvx aignostics application run prepare he-tme:v0.50.0 tcga_luad/metadata.csv tcga_luad
-# Edit the metadata.csv to insert the required information about the tissue type and disease
-nano tcga_luad/metadata.csv # Adapt to your favourite editor
+uvx aignostics application run prepare he-tme data/tcga_luad/run.csv data/
+# Edit the metadata.csv to insert the required information about the staining method, tissue type and disease
+# Adapt to your favourite editor
+nano tcga_luad/metadata.csv 
 # Upload the metadata.csv and referenced whole slide images to the Aignostics Platform
-uvx aignostics application run upload he-tme:v0.50.0 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:v0.50.0 tcga_luad/metadata.csv
+uvx aignostics application run submit he-tme data/tcga_luad/run.csv
 # Check the status of the application run you triggered
 uvx aignostics application run list
-uvx aignostics application run result dowload APPLICATION_RUN_ID # Fill in the application run id
+# Incrementally download results when they become available
+# Fill in the id from the output in the previous step
+uvx aignostics application run result download APPLICATION_RUN_ID 
+```
+
+For convenience the the `application run execute` command combines preparation, upload, submission and download.
+The below is equivalent to the above, while adding additionally required metadata using a mapping
+
+```shell
+uvx aignostics dataset idc download 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 data/
+uvx aignostics application run execute he-tme data/tcga_luad/run.csv data/ ".*\.dcm:staining_method=H&E,tissue=LUNG,disease=LUNG_CANCER"
 ```
 
 The CLI provides extensive help:
 
 ```shell
-uvx aignostics --help                        # list all spaces such as application, dataset, bucket and system, 
-uvx aignostics application --help            # list subcommands in the application space
-uvx aignostics application run --help.       # list subcommands in the application run sub-space
-uvx aignostics application run list --help   # show help for specific command
+uvx aignostics --help                           # list all spaces such as application, dataset, bucket and system, 
+uvx aignostics application --help               # list subcommands in the application space
+uvx aignostics application run --help           # list subcommands in the application run sub-space
+uvx aignostics application run list --help      # show help for specific command
+uvx aignostics application run execute --help   # show help for another command
 ```
 
 Check out our
@@ -242,10 +255,11 @@ 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.
 
-We provide Jupyter and Marimo notebooks to help you get started with the SDK.
-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
+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, 
+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))
 or [Marimo](https://marimo.io/)
@@ -267,7 +281,7 @@ uv run marimo edit examples/notebook.py
 > You can as well run a notebook within the Aignostics Launchpad. To do so, select the
 > Run you want to inspect in the left sidebar, and click the button "Open in Python Notebook".
 
-### Aignostics Client Library: Call the Aignostics Platform API from your Python scripts
+### Client Library: Call the Aignostics Platform API from your Python scripts
 
 > [!IMPORTANT]\
 > Before you get started, you need to set up your authentication credentials if
@@ -275,35 +289,35 @@ uv run marimo edit examples/notebook.py
 > [your personal dashboard on the Aignostics Platform website](https://platform.aignostics.com/getting-started/quick-start)
 > and follow the steps outlined in the `Enterprise Integration` section.
 
-Next to using the Launchpad, CLI and notebooks, you can also use the Python SDK in your
-codebase. The following sections outline how to install the SDK and interact
-with it.
+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 
+interact with the Client.
 
 ### Installation
 
-The Aignostics Python SDK is available via the
-Adding Aignostics Python SDK to your codebase as a dependency is easy. You can
-directly add the dependency via your favourite package manager:
+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
-installed follow
-[these instructions](https://docs.astral.sh/uv/getting-started/installation/).
+installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/).
 
 ```shell
-# add SDK as dependency to your project
+# Add Aignostics Python SDK as dependency to your project
 uv add aignostics
 ```
 
 **Install with [pip](https://pip.pypa.io/en/stable/)**
 
 ```shell
-# add SDK as dependency to your project
+# Add Python SDK as dependency to your project
 pip install aignostics
 ```
 
 #### Usage
 
-The following snippet shows how to use the Python SDK to trigger an application
+The following snippet shows how to use the Client to trigger an application
 run:
 
 ```python
@@ -389,11 +403,11 @@ Self-signed URLs for files in google storage buckets can be generated using the
 for the Google Storage Bucket**
 
 
-## 3) Aignostics Platform: Concepts
+## Platform
 
 ### Overview
 
-The Aignostics Platform is a comprehensive cloud-based service that allows organizations to leverage advanced computational pathology applications without the need for specialized expertise or complex infrastructure. Via its API it provides a standardized, secure interface for accessing Aignostics' portfolio of advanced computational pathology applications. These applications perform machine learning based tissue and cell analysis on histopathology slides, delivering quantitative measurements, visual representations, and detailed statistical data.
+The **Aignostics Platform** is a comprehensive cloud-based service that allows organizations to leverage advanced computational pathology applications without the need for specialized expertise or complex infrastructure. Via its API it provides a standardized, secure interface for accessing Aignostics' portfolio of advanced computational pathology applications. These applications perform machine learning based tissue and cell analysis on histopathology slides, delivering quantitative measurements, visual representations, and detailed statistical data.
 
 ![Overview](https://raw.githubusercontent.com/aignostics/python-sdk/main/platform.png)
 
@@ -419,9 +433,10 @@ To start using the Aignostics Platform and its advanced applications, your organ
 > 3. We can integrate with your IDP system (e.g. SAML, OIDC) for user authentication. Please contact us to discuss the integration.
 > 4. Registering your organistation typically takes 2 business days depending on the complexity of the signed business agreement and specific requirements.
 
-### Aignostics Console
+### Console
 
-The web-based [*Console*](https://platform.aignostics.com) of the Aignostics Platform is a user-friendly interface that allows you to manage your organization, applications, quotas, and users. It provides a centralized location for accessing all features and functionalities of the platform. 
+The web-based [*Aignostics Console*](https://platform.aignostics.com) is a user-friendly interface that allows you to 
+manage your organization, applications, quotas, and users registered with the Aignostics Platform.
 
 1. The Console is available to users registered for your organisation to manage their profile and monitor usage of their quota.
 2. Administrators of your organization can invite additional users, manage the organisation and user specific quotas and monitor usage.
@@ -482,7 +497,7 @@ Visit the [Console](https://platform.aignostics.com) to check your current quota
 
 ### API
 
-The Aignostics Platform API is a RESTful web service that allows you to interact with the platform programmatically. It provides endpoints for submitting whole slide images (WSIs) for analysis, checking the status of application runs, and retrieving results.
+The **Aignostics Platform API** is a RESTful web service that allows you to interact with the platform programmatically. It provides endpoints for submitting whole slide images (WSIs) for analysis, checking the status of application runs, and retrieving results.
 
 You can interact with the API using the Python client, which is a wrapper around the RESTful API. The Python client simplifies the process of making requests to the API and handling responses. It also provides convenient methods for uploading WSIs, checking application run status, and downloading results.
 
@@ -495,7 +510,7 @@ Every WSI processed by the Platform generates a cost. Usage of the "Test Applica
 **[Read the API reference documentation](https://aignostics.readthedocs.io/en/latest/api_reference_v1.html)** or use our **[Interactive API Explorer](https://platform.aignostics.com/explore-api)** to dive into details of all operations and parameters.
 
 
-## 4) Further Reading
+## Further Reading
 
 1. Inspect our
    [security policy](https://aignostics.readthedocs.io/en/latest/security.html)
@@ -520,7 +535,7 @@ Every WSI processed by the Platform generates a cost. Usage of the "Test Applica
    that this project builds upon. Thank you to all these wonderful contributors!
 
 
-## 5) Glossary
+## Glossary
 
 ### A
 

{aignostics-0.2.2 → aignostics-0.2.10}/README.md

@@ -20,7 +20,7 @@
 ---
 
 
-## 1) Introduction
+## Introduction
 
 The **Aignostics Python SDK** includes multiple pathways to interact with the
 **Aignostics Platform**:
@@ -57,13 +57,15 @@ more about how we achieve
 [operational excellence](https://aignostics.readthedocs.io/en/latest/operational_excellence.html) and
 [security](https://aignostics.readthedocs.io/en/latest/security.html).
 
-## 2) Quick Start
+## 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, please jump to section 3 below.
+> 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.
 
-### Aignostics Launchpad: Run your first computational pathology analysis in 10 minutes from your desktop
+### 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. 
@@ -77,9 +79,9 @@ The Launchpad is available for Mac OS X, Windows, and Linux, and can be installe
 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.
 
-### Aignostics CLI: Manage datasets and application runs from your terminal
+### CLI: Manage datasets and application runs from your terminal
 
-The Aignostics 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 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
@@ -88,29 +90,41 @@ H&E-TME application](https://www.aignostics.com/products/he-tme-profiling-produc
 ```shell
 # Download a sample dataset from the NCI Image Data Commons (IDC) portal to your current working directory
 # As the dataset id refers to the TCGA LUAD collection, this creates a directory tcga_luad with the DICOM files
-uvx aignostics dataset idc download 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 .
+uvx aignostics dataset idc download 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 data/
 # Prepare the metadata for the application run by creating a metadata.csv, extracting 
 # the required metadata from the DICOM files. We furthermore add the required
 # information about the tissue type and disease. TODO (Helmut): Update
-uvx aignostics application run prepare he-tme:v0.50.0 tcga_luad/metadata.csv tcga_luad
-# Edit the metadata.csv to insert the required information about the tissue type and disease
-nano tcga_luad/metadata.csv # Adapt to your favourite editor
+uvx aignostics application run prepare he-tme data/tcga_luad/run.csv data/
+# Edit the metadata.csv to insert the required information about the staining method, tissue type and disease
+# Adapt to your favourite editor
+nano tcga_luad/metadata.csv 
 # Upload the metadata.csv and referenced whole slide images to the Aignostics Platform
-uvx aignostics application run upload he-tme:v0.50.0 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:v0.50.0 tcga_luad/metadata.csv
+uvx aignostics application run submit he-tme data/tcga_luad/run.csv
 # Check the status of the application run you triggered
 uvx aignostics application run list
-uvx aignostics application run result dowload APPLICATION_RUN_ID # Fill in the application run id
+# Incrementally download results when they become available
+# Fill in the id from the output in the previous step
+uvx aignostics application run result download APPLICATION_RUN_ID 
+```
+
+For convenience the the `application run execute` command combines preparation, upload, submission and download.
+The below is equivalent to the above, while adding additionally required metadata using a mapping
+
+```shell
+uvx aignostics dataset idc download 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 data/
+uvx aignostics application run execute he-tme data/tcga_luad/run.csv data/ ".*\.dcm:staining_method=H&E,tissue=LUNG,disease=LUNG_CANCER"
 ```
 
 The CLI provides extensive help:
 
 ```shell
-uvx aignostics --help                        # list all spaces such as application, dataset, bucket and system, 
-uvx aignostics application --help            # list subcommands in the application space
-uvx aignostics application run --help.       # list subcommands in the application run sub-space
-uvx aignostics application run list --help   # show help for specific command
+uvx aignostics --help                           # list all spaces such as application, dataset, bucket and system, 
+uvx aignostics application --help               # list subcommands in the application space
+uvx aignostics application run --help           # list subcommands in the application run sub-space
+uvx aignostics application run list --help      # show help for specific command
+uvx aignostics application run execute --help   # show help for another command
 ```
 
 Check out our
@@ -125,10 +139,11 @@ 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.
 
-We provide Jupyter and Marimo notebooks to help you get started with the SDK.
-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
+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, 
+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))
 or [Marimo](https://marimo.io/)
@@ -150,7 +165,7 @@ uv run marimo edit examples/notebook.py
 > You can as well run a notebook within the Aignostics Launchpad. To do so, select the
 > Run you want to inspect in the left sidebar, and click the button "Open in Python Notebook".
 
-### Aignostics Client Library: Call the Aignostics Platform API from your Python scripts
+### Client Library: Call the Aignostics Platform API from your Python scripts
 
 > [!IMPORTANT]\
 > Before you get started, you need to set up your authentication credentials if
@@ -158,35 +173,35 @@ uv run marimo edit examples/notebook.py
 > [your personal dashboard on the Aignostics Platform website](https://platform.aignostics.com/getting-started/quick-start)
 > and follow the steps outlined in the `Enterprise Integration` section.
 
-Next to using the Launchpad, CLI and notebooks, you can also use the Python SDK in your
-codebase. The following sections outline how to install the SDK and interact
-with it.
+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 
+interact with the Client.
 
 ### Installation
 
-The Aignostics Python SDK is available via the
-Adding Aignostics Python SDK to your codebase as a dependency is easy. You can
-directly add the dependency via your favourite package manager:
+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
-installed follow
-[these instructions](https://docs.astral.sh/uv/getting-started/installation/).
+installed follow [these instructions](https://docs.astral.sh/uv/getting-started/installation/).
 
 ```shell
-# add SDK as dependency to your project
+# Add Aignostics Python SDK as dependency to your project
 uv add aignostics
 ```
 
 **Install with [pip](https://pip.pypa.io/en/stable/)**
 
 ```shell
-# add SDK as dependency to your project
+# Add Python SDK as dependency to your project
 pip install aignostics
 ```
 
 #### Usage
 
-The following snippet shows how to use the Python SDK to trigger an application
+The following snippet shows how to use the Client to trigger an application
 run:
 
 ```python
@@ -272,11 +287,11 @@ Self-signed URLs for files in google storage buckets can be generated using the
 for the Google Storage Bucket**
 
 
-## 3) Aignostics Platform: Concepts
+## Platform
 
 ### Overview
 
-The Aignostics Platform is a comprehensive cloud-based service that allows organizations to leverage advanced computational pathology applications without the need for specialized expertise or complex infrastructure. Via its API it provides a standardized, secure interface for accessing Aignostics' portfolio of advanced computational pathology applications. These applications perform machine learning based tissue and cell analysis on histopathology slides, delivering quantitative measurements, visual representations, and detailed statistical data.
+The **Aignostics Platform** is a comprehensive cloud-based service that allows organizations to leverage advanced computational pathology applications without the need for specialized expertise or complex infrastructure. Via its API it provides a standardized, secure interface for accessing Aignostics' portfolio of advanced computational pathology applications. These applications perform machine learning based tissue and cell analysis on histopathology slides, delivering quantitative measurements, visual representations, and detailed statistical data.
 
 ![Overview](https://raw.githubusercontent.com/aignostics/python-sdk/main/platform.png)
 
@@ -302,9 +317,10 @@ To start using the Aignostics Platform and its advanced applications, your organ
 > 3. We can integrate with your IDP system (e.g. SAML, OIDC) for user authentication. Please contact us to discuss the integration.
 > 4. Registering your organistation typically takes 2 business days depending on the complexity of the signed business agreement and specific requirements.
 
-### Aignostics Console
+### Console
 
-The web-based [*Console*](https://platform.aignostics.com) of the Aignostics Platform is a user-friendly interface that allows you to manage your organization, applications, quotas, and users. It provides a centralized location for accessing all features and functionalities of the platform. 
+The web-based [*Aignostics Console*](https://platform.aignostics.com) is a user-friendly interface that allows you to 
+manage your organization, applications, quotas, and users registered with the Aignostics Platform.
 
 1. The Console is available to users registered for your organisation to manage their profile and monitor usage of their quota.
 2. Administrators of your organization can invite additional users, manage the organisation and user specific quotas and monitor usage.
@@ -365,7 +381,7 @@ Visit the [Console](https://platform.aignostics.com) to check your current quota
 
 ### API
 
-The Aignostics Platform API is a RESTful web service that allows you to interact with the platform programmatically. It provides endpoints for submitting whole slide images (WSIs) for analysis, checking the status of application runs, and retrieving results.
+The **Aignostics Platform API** is a RESTful web service that allows you to interact with the platform programmatically. It provides endpoints for submitting whole slide images (WSIs) for analysis, checking the status of application runs, and retrieving results.
 
 You can interact with the API using the Python client, which is a wrapper around the RESTful API. The Python client simplifies the process of making requests to the API and handling responses. It also provides convenient methods for uploading WSIs, checking application run status, and downloading results.
 
@@ -378,7 +394,7 @@ Every WSI processed by the Platform generates a cost. Usage of the "Test Applica
 **[Read the API reference documentation](https://aignostics.readthedocs.io/en/latest/api_reference_v1.html)** or use our **[Interactive API Explorer](https://platform.aignostics.com/explore-api)** to dive into details of all operations and parameters.
 
 
-## 4) Further Reading
+## Further Reading
 
 1. Inspect our
    [security policy](https://aignostics.readthedocs.io/en/latest/security.html)
@@ -403,7 +419,7 @@ Every WSI processed by the Platform generates a cost. Usage of the "Test Applica
    that this project builds upon. Thank you to all these wonderful contributors!
 
 
-## 5) Glossary
+## Glossary
 
 ### A
 

{aignostics-0.2.2 → aignostics-0.2.10}/examples/e2e.py

@@ -42,7 +42,7 @@ def _():
     import shapely
     from cloudpathlib import GSPath
     from dotenv import load_dotenv
-    from idc_index import index
+    from aignostics import dataset
     from PIL import Image, ImageDraw
     from shapely.affinity import translate
     from shapely.geometry import Polygon, box
@@ -80,7 +80,7 @@ def _():
             restrict_navigation=True,
         )
     ])  # type: ignore
-    return Path, WsiDicom, index, mo, plt
+    return Path, WsiDicom, dataset, mo, plt
 
 
 @app.cell
@@ -97,8 +97,8 @@ def _(Path, mo):
 
 
 @app.cell
-def _(index):
-    idc_client = index.IDCClient()  # set-up idc_client
+def _(dataset):
+    idc_client = dataset.IDCClient()  # set-up idc_client
     idc_client.fetch_index("sm_instance_index")
     return (idc_client,)
 

{aignostics-0.2.2 → aignostics-0.2.10}/examples/notebook.py

@@ -2,7 +2,7 @@
 # requires-python = ">=3.13"
 # dependencies = [
 #     "marimo",
-#     "aignostics==0.2.2",
+#     "aignostics==0.2.10",
 # ]
 # ///
 

{aignostics-0.2.2 → aignostics-0.2.10}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "aignostics"
-version = "0.2.2"
-description = "🔬 Python SDK providing access to Aignostics AI services."
+version = "0.2.10"
+description = "🔬 Python SDK providing access to the Aignostics Platform. Includes Aignostics Launchpad (Desktop Application), Aignostics CLI (Command-Line Interface), example notebooks, and Aignostics Client Library."
 readme = "README.md"
 authors = [
     { name = "Helmut Hoffer von Ankershoffen", email = "helmut@aignostics.com" },
-    { name = "Andreas Kuhn" },
+    { name = "Andreas Kunft", email = "andreas@aignostics.com" },
 ]
 license = { file = "LICENSE" }
 
@@ -354,7 +354,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.2.2"
+current_version = "0.2.10"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"