Skip to content
Open
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
32 changes: 28 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ You will need [Python 3.5+](https://www.python.org/) or later. Earlier versions

### Installing from package

You can get the .whl file from releases and install it through:
You can get the package from [pypi](https://pypi.org/project/osc-sdk/):
```
pip3 install osc_sdk-1.2-py3-none-any.whl
pip3 install osc-sdk
```

### Installing from sources
Expand All @@ -37,17 +37,41 @@ The CLI requires a configuration file in `~/.osc_sdk/config.json` The content mu
```json
{"default":
{"access_key": "MYACCESSKEY",
"client_certificate": "my-cert-filename",
"secret_key": "MYSECRETKEY",
"host": "outscale.com",
"https": true,
"method": "POST",
"region_name": "eu-west-2"
},
"us":
{"access_key": "MYACCESSKEY",
"secret_key": "MYSECRETKEY",
"host": "outscale.com",
"https": true,
"method": "POST",
"region_name": "us-east-2"
}
}
```
You can add several profiles for different regions or users.

Optional parameters can be applied to each profile :
* client_certificate: if you need additional security, your pem must include your private key and your certificate
* version: if you want to query another version of the API

```json
{"default":
{"access_key": "MYACCESSKEY",
"secret_key": "MYSECRETKEY",
"client_certificate" : "path_to_your_pem",
"host": "outscale.com",
"https": true,
"method": "POST",
"region_name": "eu-west-2",
"version": "2018-11-19"
}
}
```
You can add several profiles for different regions or users.

## Usage

Expand Down