Skip to content

Commit 1152e4b

Browse files
authored
README updated
1 parent db3d690 commit 1152e4b

1 file changed

Lines changed: 28 additions & 4 deletions

File tree

readme.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ You will need [Python 3.5+](https://www.python.org/) or later. Earlier versions
1212

1313
### Installing from package
1414

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

2020
### Installing from sources
@@ -37,17 +37,41 @@ The CLI requires a configuration file in `~/.osc_sdk/config.json` The content mu
3737
```json
3838
{"default":
3939
{"access_key": "MYACCESSKEY",
40-
"client_certificate": "my-cert-filename",
4140
"secret_key": "MYSECRETKEY",
4241
"host": "outscale.com",
4342
"https": true,
4443
"method": "POST",
44+
"region_name": "eu-west-2"
45+
},
46+
"us":
47+
{"access_key": "MYACCESSKEY",
48+
"secret_key": "MYSECRETKEY",
49+
"host": "outscale.com",
50+
"https": true,
51+
"method": "POST",
52+
"region_name": "us-east-2"
53+
}
54+
}
55+
```
56+
You can add several profiles for different regions or users.
57+
58+
Optional parameters can be applied to each profile :
59+
* client_certificate: if you need additional security, your pem must include your private key and your certificate
60+
* version: if you want to query another version of the API
61+
62+
```json
63+
{"default":
64+
{"access_key": "MYACCESSKEY",
65+
"secret_key": "MYSECRETKEY",
66+
"client_certificate" : "path_to_your_pem",
67+
"host": "outscale.com",
68+
"https": true,
69+
"method": "POST",
4570
"region_name": "eu-west-2",
4671
"version": "2018-11-19"
4772
}
4873
}
4974
```
50-
You can add several profiles for different regions or users.
5175

5276
## Usage
5377

0 commit comments

Comments
 (0)