The CLI enables us to operate resources on Lightdash.
Project description
lightdash-ops
This is a python-based Lightdash. It focuses on to operate resources like users' roles and spaces on Lightdash by calling, as the official CLI, as The Lightdash CLI | Documentation | Lightdash enables us to deploy projects and so on. For instance, we can get members
Install
pip install -U lightdash-ops
Settings
We can configure the API endpoint and so on with environment variables.
We can also take advantage of an .env
file.
The template is located at .env.template.
# .env
LIGHTDASH_URL=https://localhost:8000
...
How to use
The CLI requires a personal access token to call the Lightdash APIs. The official documentation describes how to get personal access tokens.
The CLI provides many sub commands. Please refer to the detailed documentation in docs/cli.ms.
Example
The subsequent command is used to get all members in an organization.
$ export LIGHTDASH_URL="https://localhost:8000"
$ export LIGHTDASH_API_KEY="YOUR-LIGHTDASH-PERSONAL-ACCESS-TOKEN"
$ lightdash-ops organization get-members
[
{
"member_uuid": "ade0aef5-bca8-4cbe-819b-07803390ffb0",
"email": "lightdash-member@example.com",
"role": "member"
},
{
"member_uuid": "d7ee948b-26d6-461a-b289-906cc7bb0c73",
"email": "lightdash-admin@example.com",
"role": "admin"
}
]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for lightdash_ops-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6643299097dfaab022f9e7601f426e560bf9b206e89e92149934509d1491a14 |
|
MD5 | 259ec3a4b7f3028ef56a34fe986ca804 |
|
BLAKE2b-256 | 71062e0a5ea6370d5bed78560e97b06ecb9a660df74d7ef7a0726a09f4081f3a |