| Name | lightdash-ops JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | The CLI enables us to operate resources on Lightdash. |
| upload_time | 2024-09-12 06:45:48 |
| maintainer | None |
| docs_url | None |
| author | yu-iskw |
| requires_python | >=3.9.0 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# lightdash-ops
This is a python-based [Lightdash](https://www.lightdash.com/).
It focuses on to operate resources like users' roles and spaces on Lightdash by calling, as [the official CLI](https://docs.lightdash.com/api/v1/), as [The Lightdash CLI \| Documentation \| Lightdash](https://docs.lightdash.com/guides/cli/intro/) enables us to deploy projects and so on.
For instance, we can get members
## Install
```commandline
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.template).
```commandline
# .env
LIGHTDASH_URL=https://localhost:8000
...
```
### How to use
The CLI requires a personal access token to call the Lightdash APIs.
[The official documentation](https://docs.lightdash.com/references/personal_tokens/) describes how to get personal access tokens.
The CLI provides many sub commands.
Please refer to the detailed documentation in [docs/cli.ms](./docs/cli.md).
#### Example
The subsequent command is used to get all members in an organization.
```commandline
$ 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"
}
]
```
Raw data
{
"_id": null,
"home_page": null,
"name": "lightdash-ops",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": null,
"author": "yu-iskw",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/79/2a/fadf7486ed4c50315e46a635228384528704b27670e8e10d96552d489742/lightdash_ops-0.3.1.tar.gz",
"platform": null,
"description": "# lightdash-ops\n\nThis is a python-based [Lightdash](https://www.lightdash.com/).\nIt focuses on to operate resources like users' roles and spaces on Lightdash by calling, as [the official CLI](https://docs.lightdash.com/api/v1/), as [The Lightdash CLI \\| Documentation \\| Lightdash](https://docs.lightdash.com/guides/cli/intro/) enables us to deploy projects and so on.\nFor instance, we can get members\n\n## Install\n\n```commandline\npip install -U lightdash-ops\n```\n\n## Settings\n\nWe can configure the API endpoint and so on with environment variables.\nWe can also take advantage of an `.env` file.\nThe template is located at [.env.template](.env.template).\n\n```commandline\n# .env\nLIGHTDASH_URL=https://localhost:8000\n...\n```\n\n### How to use\n\nThe CLI requires a personal access token to call the Lightdash APIs.\n[The official documentation](https://docs.lightdash.com/references/personal_tokens/) describes how to get personal access tokens.\n\nThe CLI provides many sub commands.\nPlease refer to the detailed documentation in [docs/cli.ms](./docs/cli.md).\n\n#### Example\n\nThe subsequent command is used to get all members in an organization.\n\n```commandline\n$ export LIGHTDASH_URL=\"https://localhost:8000\"\n$ export LIGHTDASH_API_KEY=\"YOUR-LIGHTDASH-PERSONAL-ACCESS-TOKEN\"\n$ lightdash-ops organization get-members\n[\n {\n \"member_uuid\": \"ade0aef5-bca8-4cbe-819b-07803390ffb0\",\n \"email\": \"lightdash-member@example.com\",\n \"role\": \"member\"\n },\n {\n \"member_uuid\": \"d7ee948b-26d6-461a-b289-906cc7bb0c73\",\n \"email\": \"lightdash-admin@example.com\",\n \"role\": \"admin\"\n }\n]\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "The CLI enables us to operate resources on Lightdash.",
"version": "0.3.1",
"project_urls": {
"Home": "https://github.com/yu-iskw/lightdash-ops"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "71062e0a5ea6370d5bed78560e97b06ecb9a660df74d7ef7a0726a09f4081f3a",
"md5": "259ec3a4b7f3028ef56a34fe986ca804",
"sha256": "f6643299097dfaab022f9e7601f426e560bf9b206e89e92149934509d1491a14"
},
"downloads": -1,
"filename": "lightdash_ops-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "259ec3a4b7f3028ef56a34fe986ca804",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 78108,
"upload_time": "2024-09-12T06:45:47",
"upload_time_iso_8601": "2024-09-12T06:45:47.015787Z",
"url": "https://files.pythonhosted.org/packages/71/06/2e0a5ea6370d5bed78560e97b06ecb9a660df74d7ef7a0726a09f4081f3a/lightdash_ops-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "792afadf7486ed4c50315e46a635228384528704b27670e8e10d96552d489742",
"md5": "3fc39f237cac9b15f462b4ce847f7700",
"sha256": "10460851c44b1765724bcbe47c5c31cd699879bba3406b41f8eb5a329f6a327e"
},
"downloads": -1,
"filename": "lightdash_ops-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "3fc39f237cac9b15f462b4ce847f7700",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 36781,
"upload_time": "2024-09-12T06:45:48",
"upload_time_iso_8601": "2024-09-12T06:45:48.739420Z",
"url": "https://files.pythonhosted.org/packages/79/2a/fadf7486ed4c50315e46a635228384528704b27670e8e10d96552d489742/lightdash_ops-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 06:45:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yu-iskw",
"github_project": "lightdash-ops",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lightdash-ops"
}
