Skip to content

Commit

Permalink
deploy: f8158f5
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Dec 24, 2024
0 parents commit e43317f
Show file tree
Hide file tree
Showing 589 changed files with 858,744 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
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 added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/source/modules.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.account.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.account.v2.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.account.v3.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.applesilicon.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.audit_trail.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.baremetal.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.baremetal.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.baremetal.v3.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.billing.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.billing.v2beta1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.block.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.block.v1alpha1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.cockpit.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.cockpit.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.cockpit.v1beta1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.container.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.dedibox.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.dedibox.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.document_db.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.domain.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.domain.v2beta1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.edge_services.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.flexibleip.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.function.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.iam.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.iam.v1alpha1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.inference.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.instance.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.instance.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.interlink.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.iot.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.iot.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.ipam.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.ipam.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.ipfs.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.ipfs.v1alpha1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.jobs.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.jobs.v1alpha1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.k8s.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.k8s.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.key_manager.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.lb.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.lb.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.marketplace.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.marketplace.v2.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.mnq.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.mnq.v1beta1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.mongodb.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.qaas.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.qaas.v1alpha1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.rdb.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.rdb.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.redis.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.redis.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.registry.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.registry.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.secret.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.secret.v1alpha1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.secret.v1beta1.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway.std.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.tem.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.tem.v1alpha1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.test.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.test.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.vpc.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.vpc.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.vpc.v2.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.vpcgw.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.vpcgw.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.webhosting.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway.webhosting.v1.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.account.doctree
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 added .doctrees/source/scaleway_async.baremetal.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.billing.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.block.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.cockpit.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.container.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.dedibox.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.domain.doctree
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 added .doctrees/source/scaleway_async.function.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.iam.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.inference.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.instance.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.interlink.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.iot.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.iot.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.ipam.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.ipam.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.ipfs.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.jobs.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.k8s.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.k8s.v1.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.lb.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.lb.v1.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.mnq.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.mongodb.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.qaas.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.rdb.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.rdb.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.redis.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.redis.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.registry.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.secret.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.std.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.tem.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.test.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.test.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.vpc.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.vpc.v1.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.vpc.v2.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.vpcgw.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_async.vpcgw.v1.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/source/scaleway_core.bridge.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_core.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_core.profile.doctree
Binary file not shown.
Binary file added .doctrees/source/scaleway_core.utils.doctree
Binary file not shown.
Binary file not shown.
Empty file added .nojekyll
Empty file.
110 changes: 110 additions & 0 deletions _sources/index.rst.txt
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`
7 changes: 7 additions & 0 deletions _sources/source/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
scaleway-async
==============

.. toctree::
:maxdepth: 4

scaleway_async
19 changes: 19 additions & 0 deletions _sources/source/scaleway.account.rst.txt
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:
37 changes: 37 additions & 0 deletions _sources/source/scaleway.account.v2.rst.txt
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:
37 changes: 37 additions & 0 deletions _sources/source/scaleway.account.v3.rst.txt
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:
18 changes: 18 additions & 0 deletions _sources/source/scaleway.applesilicon.rst.txt
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:
45 changes: 45 additions & 0 deletions _sources/source/scaleway.applesilicon.v1alpha1.rst.txt
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:
18 changes: 18 additions & 0 deletions _sources/source/scaleway.audit_trail.rst.txt
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:
37 changes: 37 additions & 0 deletions _sources/source/scaleway.audit_trail.v1alpha1.rst.txt
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:
19 changes: 19 additions & 0 deletions _sources/source/scaleway.baremetal.rst.txt
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:
Loading

0 comments on commit e43317f

Please sign in to comment.