Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 1 addition & 74 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,80 +40,7 @@ pip install saagieapi==<version>
| >= 2023.01 | >= 2.4.0 |
| >= 2023.02 | >= 2.6.0 |
| >= 2023.03 | >= 2.7.0 |

## Usage

All the implemented features are documented in the [Wiki](https://github.com/saagie/api-saagie/wiki)

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

```python
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:

```python
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.

```python
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](https://github.com/saagie/api-saagie/wiki#connecting-to-your-platform).
| >= 2023.04 | >= 2.9.0 |

## Contributing

Expand Down
115 changes: 0 additions & 115 deletions docs/README.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Compatibility with your Saagie platform
>= 2023.01 >= 2.4.0
>= 2023.02 >= 2.6.0
>= 2023.03 >= 2.7.0
>= 2023.04 >= 2.9.0
=========================== ======================

Usage
Expand Down