Skip to main content

Python SDK to query Scaleway APIs.

Project description

Python SDK to query Scaleway’s APIs.

Stable release: Last release Python versions Software license Requirements freshness

Development: Unit-tests status Coverage Status Code Quality

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:read for the service compute for the organization 9a096d36-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.

Changes for v1.7.0 (2018-12-14)

  • Add jwt support in api-account

Full changelog.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scaleway-sdk-1.7.0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distributions

scaleway_sdk-1.7.0-py2.py3-none-any.whl (17.6 kB view details)

Uploaded Python 2 Python 3

scaleway_sdk-1.7.0-py2.7.egg (33.2 kB view details)

Uploaded Source

File details

Details for the file scaleway-sdk-1.7.0.tar.gz.

File metadata

  • Download URL: scaleway-sdk-1.7.0.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for scaleway-sdk-1.7.0.tar.gz
Algorithm Hash digest
SHA256 0c54e498e900c2acb2ef1223e3a45c43108819dc977e19baedd38771ac29e824
MD5 777924685b98678cd587f58f31676c87
BLAKE2b-256 b9fdd2bcaf1c4234b6124c8288522b6a7448893f64c254c60b1d172972daeb36

See more details on using hashes here.

File details

Details for the file scaleway_sdk-1.7.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for scaleway_sdk-1.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b42274b07ed205cd12d88b47a2dd7b939d9be510e342bfa5d1fa2a92324f1ff6
MD5 74b0379db1c86211998a4ec63149ee82
BLAKE2b-256 cbcc00e8d8a5006ed0b241ab8c9d1a08bcd869daf97713936439fb310e56afcc

See more details on using hashes here.

File details

Details for the file scaleway_sdk-1.7.0-py2.7.egg.

File metadata

  • Download URL: scaleway_sdk-1.7.0-py2.7.egg
  • Upload date:
  • Size: 33.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for scaleway_sdk-1.7.0-py2.7.egg
Algorithm Hash digest
SHA256 48ca1ec0d3c9a9d4cffa506f7e533742f1a3b4ff906217f819dfceab868b8a9e
MD5 aa83f7c9dd06683df9fcf693c158ae88
BLAKE2b-256 3d35670ed03e7aa3f8b1db85b37a12bc984a98cb1ad9ef69352ab2baf32e8aa1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page