Skip to content
Kelly Ferrone edited this page Apr 22, 2024 · 2 revisions

Duplo Client

::: duplocloud.client.DuploClient options: members: none heading_level: 2 show_symbol_type_toc: true

Instantiation

These are a few static methods which instantiate new instances a few different ways. You can also just use the normal init constructor method to build it up manually.

::: duplocloud.client.DuploClient.init options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.from_env options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.from_args options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.from_creds options: heading_level: 3 show_root_heading: true show_root_full_path: false

Properties

These are the properties of the DuploClient class.

::: duplocloud.client.DuploClient.token options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.host options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.settings options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.context options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.tenant options: heading_level: 3 show_root_heading: true show_root_full_path: false

API Request Methods

The following methods are used to make requests to the Duplo API. They are simply the standard HTTP methods with scoped into the configured host and token.

::: duplocloud.client.DuploClient.get options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.post options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.put options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.delete options: heading_level: 3 show_root_heading: true show_root_full_path: false

Injection

Duploctl is a plugin framework which takes advantage of the Python entrypoints system in the pyproject.toml file. This allows you to inject your own custom classes into the DuploClient class.

::: duplocloud.client.DuploClient.load options: heading_level: 3 show_root_heading: true show_root_full_path: false

::: duplocloud.client.DuploClient.format options: heading_level: 3 show_root_heading: true show_root_full_path: false

Clone this wiki locally