-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit e43317f
Showing
589 changed files
with
858,744 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 2af88cde089073ff796fac72526bc3bb | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
.. Scaleway Python SDK documentation master file, created by | ||
sphinx-quickstart on Fri Oct 21 12:20:18 2022. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
######################################### | ||
Scaleway Python SDK documentation | ||
######################################### | ||
|
||
Installation | ||
============ | ||
|
||
This library is made to work with Python 3.8 but should work on the latest versions too. | ||
|
||
The SDK is available in two flavors, a synchronous and an asynchronous one. | ||
|
||
Install from PyPI:: | ||
|
||
pip install scaleway | ||
|
||
Install from PyPI (async):: | ||
|
||
pip install scaleway-async | ||
|
||
Initialization | ||
============== | ||
|
||
You'll need a pair of access and secret keys to connect to Scaleway API. Please check the `documentation <https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys>`_ on how to retrieve them. | ||
|
||
:mod:`scaleway` APIs must be initialized with a :class:`scaleway.Client`. | ||
|
||
A **minimal setup** would look like this:: | ||
|
||
from scaleway import Client | ||
from scaleway.registry.v1 import RegistryV1API | ||
|
||
client = Client( | ||
access_key="SCWXXXXXXXXXXXXXXXXX", | ||
secret_key="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", | ||
default_project_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", | ||
default_region="fr-par", | ||
default_zone="fr-par-1", | ||
) | ||
|
||
registry_api = RegistryV1API(client) | ||
|
||
.. autofunction:: scaleway.Client | ||
|
||
For a simpler setup, you could retrieve the profile from either the configuration file or the environment variables:: | ||
|
||
from scaleway import Client | ||
|
||
client = Client.from_config_file_and_env() | ||
|
||
.. autofunction:: scaleway.Client.from_config_file_and_env | ||
|
||
Pagination | ||
========== | ||
|
||
We included some pagination helpers for the methods supporting the feature. Let's take :meth:`scaleway.registry.v1.RegistryV1API.list_namespaces` as an example: | ||
|
||
Retrieve the **first page**:: | ||
|
||
result = api.list_namespaces( | ||
# page=1, | ||
) | ||
|
||
.. autofunction:: scaleway.registry.v1.RegistryV1API.list_namespaces | ||
|
||
Retrieve **all the pages**:: | ||
|
||
namespaces = api.list_namespaces_all() | ||
|
||
.. autofunction:: scaleway.registry.v1.RegistryV1API.list_namespaces_all | ||
|
||
Types | ||
===== | ||
|
||
The project is coded with Python, so don't hesitate to take advantage of it. | ||
|
||
1. All **types of a product** are stored in the `scaleway.product.version` namespace. For instance, :class:`scaleway.registry.v1.Image`. | ||
|
||
Logging | ||
======= | ||
|
||
We are using the standard Python logging library. You can configure it as you wish:: | ||
|
||
import logging | ||
|
||
logger = logging.getLogger("scaleway") | ||
logger.addHandler(logging.StreamHandler()) | ||
logger.setLevel(logging.DEBUG) | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Contents: | ||
|
||
scaleway | ||
scaleway-async | ||
scaleway-core | ||
|
||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
scaleway-async | ||
============== | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
scaleway_async |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
scaleway.account package | ||
======================== | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
scaleway.account.v2 | ||
scaleway.account.v3 | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: scaleway.account | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
scaleway.account.v2 package | ||
=========================== | ||
|
||
Submodules | ||
---------- | ||
|
||
scaleway.account.v2.api module | ||
------------------------------ | ||
|
||
.. automodule:: scaleway.account.v2.api | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
scaleway.account.v2.marshalling module | ||
-------------------------------------- | ||
|
||
.. automodule:: scaleway.account.v2.marshalling | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
scaleway.account.v2.types module | ||
-------------------------------- | ||
|
||
.. automodule:: scaleway.account.v2.types | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: scaleway.account.v2 | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
scaleway.account.v3 package | ||
=========================== | ||
|
||
Submodules | ||
---------- | ||
|
||
scaleway.account.v3.api module | ||
------------------------------ | ||
|
||
.. automodule:: scaleway.account.v3.api | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
scaleway.account.v3.marshalling module | ||
-------------------------------------- | ||
|
||
.. automodule:: scaleway.account.v3.marshalling | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
scaleway.account.v3.types module | ||
-------------------------------- | ||
|
||
.. automodule:: scaleway.account.v3.types | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: scaleway.account.v3 | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
scaleway.applesilicon package | ||
============================= | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
scaleway.applesilicon.v1alpha1 | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: scaleway.applesilicon | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
scaleway.applesilicon.v1alpha1 package | ||
====================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
scaleway.applesilicon.v1alpha1.api module | ||
----------------------------------------- | ||
|
||
.. automodule:: scaleway.applesilicon.v1alpha1.api | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
scaleway.applesilicon.v1alpha1.content module | ||
--------------------------------------------- | ||
|
||
.. automodule:: scaleway.applesilicon.v1alpha1.content | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
scaleway.applesilicon.v1alpha1.marshalling module | ||
------------------------------------------------- | ||
|
||
.. automodule:: scaleway.applesilicon.v1alpha1.marshalling | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
scaleway.applesilicon.v1alpha1.types module | ||
------------------------------------------- | ||
|
||
.. automodule:: scaleway.applesilicon.v1alpha1.types | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: scaleway.applesilicon.v1alpha1 | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
scaleway.audit\_trail package | ||
============================= | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
scaleway.audit_trail.v1alpha1 | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: scaleway.audit_trail | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
scaleway.audit\_trail.v1alpha1 package | ||
====================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
scaleway.audit\_trail.v1alpha1.api module | ||
----------------------------------------- | ||
|
||
.. automodule:: scaleway.audit_trail.v1alpha1.api | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
scaleway.audit\_trail.v1alpha1.marshalling module | ||
------------------------------------------------- | ||
|
||
.. automodule:: scaleway.audit_trail.v1alpha1.marshalling | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
scaleway.audit\_trail.v1alpha1.types module | ||
------------------------------------------- | ||
|
||
.. automodule:: scaleway.audit_trail.v1alpha1.types | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: scaleway.audit_trail.v1alpha1 | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
scaleway.baremetal package | ||
========================== | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
scaleway.baremetal.v1 | ||
scaleway.baremetal.v3 | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: scaleway.baremetal | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Oops, something went wrong.