saagieapi 0.5.6

Python API to interact with Saagie

• Presentation
• Installation
• Usage
  • Projects
• Contributing

Presentation

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

There are two subpackages that each give access to a main class whose methods allows to interact with the API :

• The manager subpackage implements the SaagieApiManager class whose methods can interact with the manager interface in Saagie (Saagie legacy)
• The projects subpackage implements the SaagieApi class whose methods can interact with the Projects interface in Saagie (current main interface)

Installing

pip install saagieapi==<version>

Usage

Projects

from saagieapi.projects 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.create_project(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.create_job(job_name="Python test job",
                             project_id=project_id,
                             file='<path-to-local-file>',
                             description='Amazing python job',
                             category='Processing',
                             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.run_job_callback(job_id=job_id, freq=10, timeout=-1)

Contributing

All contributions are made with the pull-request system. Please follow the following steps:

• Create an issue with the correct label (i.e. Documentation/Bug/Feature)
• Create a new branch starting with the issue type : feat/..., fix/... or doc/.... GitHub Action (CI) will be triggered on each push on your branch. Warning, after the first push on your branch, an automatic commit/push will be made by the CI in order to increment the version. Thus, remember to update your repository after your first commit.
• Implement your change
• Open a Pull Request (don't forget to link the PR to the issue)
• PR will be reviewed by the Professional Service Team and merged if all the checks are successful

Commits Guidelines

We're using the Python Semantic Release library to manage our versioning.

In order to work properly, you need to follow the Emoji Parser commit style when squashing the commits during the merge of the PR to master.

• Messages with :ambulance:, :lock:, :bug:, :zap:, :goal_net:, :alien:, :wheelchair:, :speech_balloon:, :mag:, :apple:, :penguin:, :checkered_flag:, :robot:, :green_apple: emojis in the commit will make the release process to bump the patch version
• Messages with :sparkles:, :children_crossing:, :lipstick:, :iphone:, :egg:, :chart_with_upwards_trend: emojis in the commit will make the release process to bump the minor version
• Messages with a :boom: emoji in the commit will make the release process to bump the major version