im-squonk2-client 1.0.1

Squonk2 Python Client

Informatics Matters Squonk2 Python Client

A Python 3 package that provides simplified access to key parts of the Informatics Matters Squonk2 service, consisting of the Authentication, and Data Manager and Account Server REST interfaces. The functions provide access to some of the key API methods, implemented initially to support execution of Jobs from a Fragalysis stack backend.

Simplified Authentication

The following Squonk2 Authentication functions are available: -

• Auth.get_access_token()

Simplified Data Manager API

The following Squonk2 Data Manager API functions are available: -

• DmApi.set_api_url()

• DmApi.get_api_url()

• DmApi.ping()

• DmApi.create_project()

• DmApi.delete_instance()

• DmApi.delete_instance_token()

• DmApi.delete_project()

• DmApi.delete_unmanaged_project_files()

• DmApi.get_available_jobs()

• DmApi.get_available_projects()

• DmApi.get_job()

• DmApi.get_job_by_version()

• DmApi.get_instance()

• DmApi.get_project()

• DmApi.get_project_instances()

• DmApi.get_task()

• DmApi.get_unmanaged_project_file()

• DmApi.get_unmanaged_project_file_with_token()

• DmApi.get_version()

• DmApi.list_project_files()

• DmApi.put_unmanaged_project_files()

• DmApi.start_job_instance()

• DmApi.set_admin_state()

A namedtuple is used as the return value for many of the methods: -

• DmApiRv

It contains a boolean success field and a dictionary msg field. The msg typically contains the underlying REST API response content (rendered as a Python dictionary), or an error message if the call failed.

Simplified Account Server API

Note

The Squonk2 Account Server API is not currently supported.

Installation

The Squonk2 package is published on PyPI and can be installed from there:

pip install im-squonk2-client

Documentation

Documentation is available in the squonk2-python-client project on Read the Docs

Get in touch

• Report bugs, suggest features or view the source code on GitHub.