Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duplocloud/duploctl
A simple Python client for DuploCloud API.
https://github.com/duplocloud/duploctl
Last synced: 2 months ago
JSON representation
A simple Python client for DuploCloud API.
- Host: GitHub
- URL: https://github.com/duplocloud/duploctl
- Owner: duplocloud
- Created: 2023-03-27T20:08:52.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T03:47:24.000Z (9 months ago)
- Last Synced: 2024-04-13T17:14:41.396Z (9 months ago)
- Language: Python
- Size: 447 KB
- Stars: 5
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Duplocloud Py Client
[](https://github.com/duplocloud/duploctl/actions/workflows/test_unit.yml) [](https://pypi.org/project/duplocloud-client/) [](https://hub.docker.com/r/duplocloud/duploctl) [
](https://github.com/duplocloud/duploctl) [
](https://cli.duplocloud.com/)
```duploctl``` is a cli and package to work with a Duplocloud portal. It is a CLI for interacting with Duplocloud resources, such as Tenants, and is designed to work seamlessly within CLI-based CI/CD pipelines. It is a fully extensible package and can be used as both a Python module and a CLI.
## Installation
From PyPi:
```sh
pip install duplocloud-client
```
From Homebrew:
```sh
brew install duplocloud/tap/duploctl
```
## Usage
Use ```duploctl``` as a CLI or as a standalone Python module called by your custom script.
### Configuration
Use the following syntax for these global arguments:
| Arg | Env Var | Description | Default | Required |
| --- | ------- | ----------- | ------- | -------- |
| --host, -H | DUPLO_HOST | The host to connect to | | Yes |
| --token, -T | DUPLO_TOKEN | The token to use for auth | | Yes |
| --tenant, -t | DUPLO_TENANT | The tenant to use for auth | default | No |
### CLI
CLI command syntax for invoking ```duploctl```
```sh
duploctl
```
### Example Usages
Full documentation is in the Wiki section.
Configure `duploctl` access with environment variables:
```sh
export DUPLO_HOST=https://example.duplocloud.net
export DUPLO_TOKEN=AQAAA...
export DUPLO_TENANT=dev01
```
List the services in a tenant:
```sh
duploctl service list
```
Register Profile for AWS:
```sh
duploctl jit update_aws_config myportal
```
Open AWS Web Console:
```sh
duploctl jit web
```
Get Kubernetes config:
```sh
duploctl jit update_kubeconfig myinfra
```
### Python Module
Spawn your client from a Python script using the ```DuploClient.from_env()``` method and arguments. The second return value are the unparsed arguments from the command line. This example uses the client as a callable using command like syntax.
```python
duplo, args = DuploClient.from_env()
t = duplo("tenant", "find", "mytenant")
print(t)
```
Spawn a client with a custom host and token from a Python script. This example loads a resource and runs a method manually.
```python
duplo = DuploClient.from_creds(host="https://example.duplocloud.net", token="mytoken")
tenants = duplo.load("tenant")
t = tenants.find("mytenant")
print(t)
```