From 78c81eb65e4d778cbe32eb1d89f993ffc0cc4fd2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Jouannet?= Date: Wed, 1 Jul 2020 13:19:56 +0200 Subject: [PATCH 1/2] improve readme.md --- readme.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index 2520329..5607255 100644 --- a/readme.md +++ b/readme.md @@ -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 @@ -37,18 +37,42 @@ 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", - "version": "2018-11-19" + "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" + } +} +``` + ## Usage ``` From 67a3fc200643a8e2bfb6b6c2b3aba1ef3c14a297 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Jouannet?= Date: Wed, 1 Jul 2020 13:22:12 +0200 Subject: [PATCH 2/2] fix json syntax --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 5607255..8689eca 100644 --- a/readme.md +++ b/readme.md @@ -67,7 +67,7 @@ Optional parameters can be applied to each profile : "host": "outscale.com", "https": true, "method": "POST", - "region_name": "eu-west-2" + "region_name": "eu-west-2", "version": "2018-11-19" } }