Macromolecular crystallography group (CPS)

aareDBclient (0.1.1a42)

Published 2026-02-19 10:09:27 +01:00 by leonarski_f

To install the package using pip, run the following command:

pip install --index-url  --extra-index-url https://pypi.org/simple aareDBclient

For more information on the PyPI registry, see the documentation.

aareDB

Dispatcher service for job and tell management

This Python package is automatically generated by the OpenAPI Generator project:

API version: 0.1.1a42
Package version: 0.1.1a42
Generator version: 7.20.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import aareDBclient

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import aareDBclient

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import aareDBclient
from aareDBclient.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = aareDBclient.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with aareDBclient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = aareDBclient.GridscanRunnerApi(api_client)
    raster_payload_model = aareDBclient.RasterPayloadModel() # RasterPayloadModel | 
    x_shared_password = 'x_shared_password_example' # str |  (optional)

    try:
        # Ingest completed raster grid and auto-link experiment run and image
        api_response = api_instance.ingest_completed_grid(raster_payload_model, x_shared_password=x_shared_password)
        print("The response of GridscanRunnerApi->ingest_completed_grid:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GridscanRunnerApi->ingest_completed_grid: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
GridscanRunnerApi	ingest_completed_grid	POST /protected_router/gridscan_runner/ingest	Ingest completed raster grid and auto-link experiment run and image
ProcessingsRunnerApi	create_merged_result	POST /protected_router/processing_runner/create_merged_result	Submit a new merged processing result
ProcessingsRunnerApi	create_result	POST /protected_router/processing_runner/processing-results	Submit new processing result
ProcessingsRunnerApi	create_sample_merge	POST /protected_router/processing_runner/create_sample_merge	Create a new merge sample entry
ProcessingsRunnerApi	download_processing_file	GET /protected_router/processing_runner/processing-files/{file_id}	Download a processing file
ProcessingsRunnerApi	list_result_files	GET /protected_router/processing_runner/processing-results/{result_id}/files	List all files for a result
ProcessingsRunnerApi	update_merge_status	POST /protected_router/processing_runner/jobs_merge/update_status	Update the status of a merge job
ProcessingsRunnerApi	update_result	PUT /protected_router/processing_runner/processing-results/{result_id}	Update an existing processing result
ProcessingsRunnerApi	update_status	POST /protected_router/processing_runner/jobs/update_status	Update the status of a job
ProcessingsRunnerApi	upload_result_files	POST /protected_router/processing_runner/processing-results/{result_id}/upload-files	Upload files to an existing processing result
SamplesRunnerApi	create_experiment_parameters_for_sample	POST /protected_router/sample_runner/samples/{sample_id}/experiment_parameters	Create experiment parameters for a sample
SamplesRunnerApi	create_sample_event	POST /protected_router/sample_runner/samples/{sample_id}/events	Create and add an event to a sample
SamplesRunnerApi	get_samples_by_beamtime	GET /protected_router/sample_runner/by-beamtime/{beamtime_id}	List all samples for a given beamtime
SamplesRunnerApi	insert_sample	POST /protected_router/sample_runner/insert_sample	Insert a manually mounted sample.
SamplesRunnerApi	upload_sample_image	POST /protected_router/sample_runner/{sample_id}/upload-images	Upload an image for a sample (linked to its most recent event)
ScanRunnerApi	ingest_completed_scan	POST /protected_router/scan_runner/ingest	Ingest completed rotation scan and auto-link experiment run
TellsRunnerApi	get_pucks_with_tell_position	GET /protected_router/tell_runner/with-tell-position	List Pucks With Current Tell Position
TellsRunnerApi	set_tell_positions	PUT /protected_router/tell_runner/set-tell-positions	Set Tell Positions for Pucks

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Requires Python: >=3.9

Details

PyPI

2026-02-19 10:09:27 +01:00

2

OpenAPI Generator community

211 KiB

Assets (2)

aaredbclient-0.1.1a42-py3-none-any.whl 138 KiB

aaredbclient-0.1.1a42.tar.gz 73 KiB

Versions (1) View all

0.1.1a42

2026-02-19