saagieapi 2.5.0

Python API to interact with Saagie

• Presentation
• Installation
• Usage
• Contributing

Presentation

The saagieapi python package implements python API wrappers to easily interact with the Saagie platform in python.

Documentation

You can find the documentation of this package here.

Installing

pip install saagieapi==<version>

Compatibility with your Saagie platform

Saagie platform version	saagie-api release
< 2.2.0	< 0.6.0
>= 2.2.0	>= 0.6.0
>= 2023.01	>= 2.4.0

Usage

All the implemented features are documented in the Wiki

Here's a full example of how to use the API:

from saagieapi import SaagieApi

saagie = SaagieApi(url_saagie="<url>",
                   id_platform="1",
                   user="<saagie-user-name>",
                   password="<saagie-user-password>",
                   realm="saagie")

# Create a project named 'Project_test' on the saagie platform
project_dict = saagie.projects.create(name="Project_test",
                                     group="<saagie-group-with-proper-permissions>",
                                     role='Manager',
                                     description='A test project')

# Save the project id
project_id = project_dict['createProject']['id']

# Create a python job named 'Python test job' inside this project
job_dict = saagie.jobs.create(job_name="Python test job",
                              project_id=project_id,
                              file='<path-to-local-file>',
                              description='Amazing python job',
                              category='Processing',
                              technology_catalog='Saagie',
                              technology='python',
                              runtime_version='3.8',
                              command_line='python {file} arg1 arg2',
                              release_note='',
                              extra_technology='')

# Save the job id
job_id = job_dict['data']['createJob']['id']

# Run the python job and wait for its completion
saagie.jobs.run_with_callback(job_id=job_id, freq=10, timeout=-1)

Connecting to your platform

There are 2 options to connect to your platform :

1. using the default constructor:

   from saagieapi import *
   saagie = SaagieApi(url_saagie="<url>",
                      id_platform="1",
                      user="<saagie-user-name>",
                      password="<saagie-user-password>",
                      realm="saagie")
   

2. Using the easy_connect alternative constructor which uses the complete URL (eg: https://mysaagie-workspace.prod.saagie.com/projects/platform/6/) and will parse it in order to retrieve the platform URL, platform id and the realm.

   from saagieapi import *
   saagie = SaagieApi.easy_connect(url_saagie_platform="<url>",
                   user="<saagie-user-name>",
                   password="<saagie-user-password>")
   

If you want to know how to find the correct values for the URL, platform id and the realm, please refer to the Wiki.

Contributing

The complete guide to contribute is available here: Contributing

:warning: Warning :warning:

This library is provided on an experimental basis and is not covered by Saagie support for the moment.