Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/outscale/osc-sdk-python
Python SDK to perform actions on Outscale API.
https://github.com/outscale/osc-sdk-python
api cloud iaas outscale python sdk sdk-python
Last synced: 7 days ago
JSON representation
Python SDK to perform actions on Outscale API.
- Host: GitHub
- URL: https://github.com/outscale/osc-sdk-python
- Owner: outscale
- License: bsd-3-clause
- Created: 2019-06-06T12:59:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T10:18:14.000Z (3 months ago)
- Last Synced: 2024-08-20T12:24:23.198Z (3 months ago)
- Topics: api, cloud, iaas, outscale, python, sdk, sdk-python
- Language: Python
- Homepage:
- Size: 188 KB
- Stars: 6
- Watchers: 9
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)
# Outscale Python SDK
This python SDK helps you to perform actions on [Outscale API](https://docs.outscale.com/api.html?python#3ds-outscale-api).
You will need to have an Outscale account, please visit [Outscale website](https://outscale.com/).
# Installation
You can install the pre-built python package through this command:
```bash
$ pip install osc-sdk-python
```
# Building
To build the package yourself:
```bash
$ make package
```
You can then install it with:
```bash
$ pip install dist/osc_sdk_python-0.31.0-py3-none-any.whl
```
# Configuration & Credentials
When you use the cli you can choose a profile. Profiles can be set with environment variables or in a file.
It checks environment variables before loading the file.
In the file, you can set a default profile, naming `default`. It will be used if you don't precise profile in command line.
## Environment variables
```bash
$ export OSC_ACCESS_KEY=
$ export OSC_SECRET_KEY=
$ # optional
$ export OSC_REGION= (default: eu-west-2)
```
## Credentials files
```json
$ cat ~/.osc/config.json
{
"default": {
"access_key": "",
"secret_key": "",
"region": ""
},
"profile_1": {
"access_key": "",
"secret_key": "",
"region": ""
},
"profile_2": {
"access_key": "",
"secret_key": "",
"region": ""
}
}
```
Notes:
* if ~/.osc/config.json is not found, ~/.oapi_credentials will be used
* Environment variables have priority over Credentials files.
## Basic Authentication
You can also use osc-sdk-python with basic authentication mechanism using your account's email and password. Note that some calls may be blocked with this method.
More details in [authentication documentation](https://docs.outscale.com/api#authentication).
Example:
```python
gw = Gateway(email="[email protected]", password="youAccountPassword")
keys = gw.ReadAccessKeys()
```
# Example
A simple example which prints all your Virtual Machine and Volume ids.
```python
from osc_sdk_python import Gateway
if __name__ == '__main__':
gw = Gateway()
print("your virtual machines:")
for vm in gw.ReadVms()["Vms"]:
print(vm["VmId"])
print("\nyour volumes:")
for volume in gw.ReadVolumes()["Volumes"]:
print(volume["VolumeId"])
```
Usage example, check [Outscale API documentation](https://docs.outscale.com/en/userguide/Home.html) for more details.
```python
from osc_sdk_python import Gateway
if __name__ == '__main__':
gw = Gateway(**{'profile': 'profile_1'})
# Calls with api Action as method
result = gw.ReadSecurityGroups(Filters={'SecurityGroupNames': ['default']})
result = gw.CreateVms(ImageId='ami-3e158364', VmType='tinav4.c2r4')
# Or raw calls:
result = gw.raw('ReadVms')
result = gw.raw('CreateVms', ImageId='ami-xx', BlockDeviceMappings=[{'/dev/sda1': {'Size': 10}}], SecurityGroupIds=['sg-aaa', 'sg-bbb'], Wrong='wrong')
```
Another example with logs
```python
from osc_sdk_python import *
if __name__ == '__main__':
gw = Gateway(**{'profile': 'profile_1'})
# what can contain LOG_KEEP_ONLY_LAST_REQ or LOG_ALL
# here we pront log in memory, in standard output and in satndard error
gw.log.config(type=LOG_MEMORY | LOG_STDIO | LOG_STDERR, what=LOG_KEEP_ONLY_LAST_REQ)
# Or raw calls:
result = gw.raw('ReadVms')
last_request = gw.log.str()
print(last_request)
```
# Known Issues
## UTF-8
Some people my encounter some issue with utf-8 which looks like this
```bash
Problem reading (…)osc_sdk_python/osc-api/outscale.yaml:'ascii' codec can't decode byte 0xe2 in position 14856: ordinal not in range(128)
```
To avoid this issue, configure you locals as follow:
```bash
LC_ALL=en_US.UTF-8
```
if you don't want your locals to be set system wide you can proceed as follow:
```bash
LC_ALL=en_US.UTF-8 pip install osc-sdk-python
```