Scaleway SDK
Python SDK to query Scaleway's APIs.
Stable release: 
Development: 
Installation
The package is available on pip. To install it in a virtualenv:
$ virtualenv my_virtualenv
$ source my_virtualenv/bin/activate
$ pip install scaleway-sdk
General principle
If you're looking to send a GET HTTP request against our APIs, like:
GET <api_url>/foo/bar
you only need to call the following pythonic code:
>>> from scaleway.apis import DummyAPI
>>> DummyAPI().query().foo.bar.get()
The magic here lies in scaleway.apis.*API instances, which all have a query method returning a slumber.API object. The latter handling all the excruciating details of the requests.
Documentation
Even if this SDK is designed to be developer-friendly and aim for self-service discovery, it is still recommended to read the official API documentation.
And because most of the provided helpers takes the form of pre-configured Slumber objects, a good read of Slumber documention is encouraged as well.
The list of available resources per API can be found [on the Scaleway API repository](https://github.com/scaleway/api.scaleway.com/blob/master/README.md#apis)
Examples
- List your organizations:
>>> from scaleway.apis import AccountAPI
>>> api = AccountAPI(auth_token='') # Set your token here!
>>> print api.query().organizations.get()
{u'organizations': [...]}
- List your organizations, but get a flask.Response object instead of a dict:
>>> from scaleway.apis import AccountAPI
>>> api = AccountAPI(auth_token='') # Set your token here!
>>> resp = api.query(serialize=False).organizations.get()
>>> print type(resp)
<Response [200]>
>>> print resp.headers
{...} # Response HTTP headers.
>>> print resp.links
{...} # Parsed "Link" HTTP header, for pagination.
>>> print resp.json()
{u'organizations': [...]}
- List your servers:
>>> from scaleway.apis import ComputeAPI
>>> api = ComputeAPI(auth_token='') # Set your token here!
>>> print api.query().servers.get()
{u'servers': [...]}
# Or choose your region, as in apis/api_compute.py
>>> api = ComputeAPI(region='ams1', auth_token='') # Set your token here!
>>> print api.query().servers.get()
{u'servers': [...]}
- Get details of a server:
>>> from scaleway.apis import ComputeAPI
>>> api = ComputeAPI(auth_token='') # Set your token here!
>>> server_id = '' # Set a server ID here!
>>> print api.query().servers(server_id).get()
{u'server': {...}}
- Check if your token has the permission
servers:readfor the servicecomputefor the organization9a096d36-6bf9-470f-91df-2398aa7361f7:
>>> from scaleway.apis import AccountAPI
>>> api = AccountAPI(auth_token='') # Set your token here!
>>> print api.has_perm(service='compute', name='servers:read',
... resource='9a096d36-6bf9-470f-91df-2398aa7361f7')
False
Development
Assuming you are in a virtualenv:
$ pip install -e .
$ python -c 'from scaleway.apis import AccountAPI'
# it works!
Test
To submit a patch, you'll need to test your code against python2.7 and python3.4. To run tests:
$ pip install nose coverage pycodestyle pylint
$ python setup.py nosetests --with-coverage
(...)
$ pycodestyle scaleway
(...)
$ pylint scaleway
(...)
- Coverage score should never be lower than before your patch.
- PEP8 should never return an error.
- Pylint score should never be lower than before your patch.
Alternatively, to run nosetests on both Python2.7 and Python3.4, you can run tox.
Alternative libraries / clients
We maintain a list of the current library/client implementations on the api.scaleway.com repository.
License
This software is licensed under a BSD 2-Clause License.
1 Oct 10, 2021
2 Jan 11, 2022
36 Dec 23, 2022
44 Jan 03, 2023
16 Dec 06, 2022
10 Dec 16, 2022
0 Nov 16, 2021
3 Jan 06, 2022
3 Mar 14, 2022
1 Dec 28, 2021
56 Dec 29, 2022
21 Dec 30, 2022
4 Sep 23, 2022
3 Dec 07, 2021
2 Dec 22, 2021
8 Sep 09, 2022
20 Sep 04, 2022
7 Oct 17, 2022
20 Nov 23, 2022
6 Oct 06, 2022