Python API to interact with Saagie
Project description
Presentation
The saagieapi
python package implements python API wrappers to easily interact with the Saagie platform in python.
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 |
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.6',
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 :
- 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")
- 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>")
Iy you wan to know how to find the correct values for the URL, platform id and the realm, please refer to the Wiki.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
saagieapi-1.0.2.tar.gz
(25.9 kB
view hashes)
Built Distribution
saagieapi-1.0.2-py3-none-any.whl
(32.0 kB
view hashes)
Close
Hashes for saagieapi-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb4800785bd2ac8ec84c93e96359c9586b288d04f99d538a54fa1e731b59c403 |
|
MD5 | 68194d018c2574ec3f93390cb4d4f4c2 |
|
BLAKE2b-256 | 9b58669ebae10f2ee1da34d97471246d917f1d7d1740e734b016bddc8af6d256 |