qarnot / qarnot-sdk-python

Python SDK to use Qarnot's computing service
Apache License 2.0
13 stars 4 forks source link

Qarnot computing Python SDK

|pypi-badge| |readthedocs-badge|

This package allows you to use Qarnot cloud computing service.

You can launch, manage and monitor payloads running on distributed computing nodes deployed in Qarnot’s digital boilers <https://qarnot.com/fr/produits/infrastructure/qb>_.

Basic usage

Create an account, retrieve your token and get free computation time on account.qarnot.com <https://account.qarnot.com>_

Launch a docker container in 7 lines:

.. code:: python

import qarnot
conn = qarnot.connection.Connection(client_token="xxxx_mytoken_xxxx")
task = conn.create_task('hello world', 'docker-batch', 4)
task.constants['DOCKER_CMD'] = 'echo hello world from node #${FRAME_ID}!'
task.run()
print(task.stdout())

Samples and documentations

You can find samples and detailed information on qarnot.com <https://qarnot.com>_.

SDK documentation is available here <https://qarnot.com/documentation/sdk-python/>_

Generating documentation

To generate the SDK documentation you can use the following command

.. code:: bash

make -C doc html

The index of the doc is then generated in doc/_build/html/index.html

.. |pypi-badge| image:: https://img.shields.io/pypi/v/qarnot.svg .. _pypi-badge: https://pypi.python.org/pypi/qarnot/ .. |readthedocs-badge| image:: https://readthedocs.org/projects/qarnot/badge/?version=latest .. _readthedocs-badge: https://qarnot.readthedocs.io/en/latest/