# Kidash [](https://github.com/chaoss/grimoirelab-kidash/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-kidash?branch=master) [](https://badge.fury.io/py/kidash)
Kidash is a tool for managing Kibana-related dashboards from the command line. The standard GrimoireLab dashboards
are available in the [Sigils](https://github.com/chaoss/grimoirelab-sigils) repository.
## Requirements
* Python >= 3.8
You will also need some other libraries for running the tool, you can find the
whole list of dependencies in [pyproject.toml](pyproject.toml) file.
## Installation
There are several ways to install Kidash on your system: packages or source
code using Poetry or pip.
### PyPI:
Kidash can be installed using pip, a tool for installing Python packages.
To do it, run the next command:
```
$ pip install kidash
```
### Source code
To install from the source code you will need to clone the repository first:
```
$ git clone https://github.com/chaoss/grimoirelab-kidash
$ cd grimoirelab-kidash
```
Then use pip or Poetry to install the package along with its dependencies.
#### Pip
To install the package from local directory run the following command:
```
$ pip install .
```
In case you are a developer, you should install kidash in editable mode:
```
$ pip install -e .
```
#### Poetry
We use [poetry](https://python-poetry.org/) for dependency management and
packaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).
Once you have installed it, you can install kidash and the dependencies:
```
$ poetry install
```
To spaw a new shell within the virtual environment use:
```
$ poetry shell
```
## Usage
- Get a list of all options with:
```
$ kidash --help
```
- Import a dashboard:
```buildoutcfg
kidash -g -e <elasticsearch-url>:<port> --import <local-file-path>
example: kidash -g -e https://admin:admin@localhost:9200 --import ./overview.json
```
- Export a dashboard:
```buildoutcfg
kidash -g -e <elasticsearch-url> --dashboard <dashboard-id>* --export <local-file-path> --split-index-pattern
example: kidash -g -e https://admin:admin@localhost:9200 --dashboard overview --export overview.json
```
## License
Licensed under GNU General Public License (GPL), version 3 or later.
Raw data
{
"_id": null,
"home_page": "https://chaoss.github.io/grimoirelab/",
"name": "kidash",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "development, grimoirelab",
"author": "GrimoireLab Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1f/b4/df801bdef7169f799f6e7ac66a40c0d03b37dc7bf9399dfbc89d734012e8/kidash-1.0.0.tar.gz",
"platform": null,
"description": "# Kidash [](https://github.com/chaoss/grimoirelab-kidash/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-kidash?branch=master) [](https://badge.fury.io/py/kidash)\n\nKidash is a tool for managing Kibana-related dashboards from the command line. The standard GrimoireLab dashboards\nare available in the [Sigils](https://github.com/chaoss/grimoirelab-sigils) repository.\n\n## Requirements\n\n * Python >= 3.8\n\nYou will also need some other libraries for running the tool, you can find the\nwhole list of dependencies in [pyproject.toml](pyproject.toml) file.\n\n## Installation\n\nThere are several ways to install Kidash on your system: packages or source \ncode using Poetry or pip.\n\n### PyPI:\n\nKidash can be installed using pip, a tool for installing Python packages. \nTo do it, run the next command:\n```\n$ pip install kidash\n```\n\n### Source code\n\nTo install from the source code you will need to clone the repository first:\n```\n$ git clone https://github.com/chaoss/grimoirelab-kidash\n$ cd grimoirelab-kidash\n```\n\nThen use pip or Poetry to install the package along with its dependencies.\n\n#### Pip\nTo install the package from local directory run the following command:\n```\n$ pip install .\n```\nIn case you are a developer, you should install kidash in editable mode:\n```\n$ pip install -e .\n```\n\n#### Poetry\nWe use [poetry](https://python-poetry.org/) for dependency management and \npackaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).\nOnce you have installed it, you can install kidash and the dependencies:\n```\n$ poetry install\n```\nTo spaw a new shell within the virtual environment use:\n```\n$ poetry shell\n```\n\n## Usage\n\n- Get a list of all options with:\n```\n$ kidash --help\n```\n\n- Import a dashboard:\n```buildoutcfg\nkidash -g -e <elasticsearch-url>:<port> --import <local-file-path>\nexample: kidash -g -e https://admin:admin@localhost:9200 --import ./overview.json\n```\n\n- Export a dashboard:\n```buildoutcfg\nkidash -g -e <elasticsearch-url> --dashboard <dashboard-id>* --export <local-file-path> --split-index-pattern\nexample: kidash -g -e https://admin:admin@localhost:9200 --dashboard overview --export overview.json\n```\n\n## License\n\nLicensed under GNU General Public License (GPL), version 3 or later.\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "GrimoireLab script to manage Kibana dashboards from the command line",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/chaoss/grimoirelab-kidash/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/chaoss/grimoirelab-kidash"
},
"split_keywords": [
"development",
" grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea09e34ddc2f212a5bca767fe5be478f9384ba51a344e0585f3b6efc98816801",
"md5": "6d0665c2ce533ca27b7a68a352a7137b",
"sha256": "c073177f0348b7bf4123bb4742b9fd3fc504462fcc2063c46891e4d7ea7f545b"
},
"downloads": -1,
"filename": "kidash-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d0665c2ce533ca27b7a68a352a7137b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 28363,
"upload_time": "2024-04-13T07:22:20",
"upload_time_iso_8601": "2024-04-13T07:22:20.200866Z",
"url": "https://files.pythonhosted.org/packages/ea/09/e34ddc2f212a5bca767fe5be478f9384ba51a344e0585f3b6efc98816801/kidash-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1fb4df801bdef7169f799f6e7ac66a40c0d03b37dc7bf9399dfbc89d734012e8",
"md5": "05ae4b2422b9139e05fd56526e1d2fff",
"sha256": "0b87c4df32fe834c8a0653cc1a74dfcd89c1b1974fef04d17b6a11954eee8354"
},
"downloads": -1,
"filename": "kidash-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "05ae4b2422b9139e05fd56526e1d2fff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 33052,
"upload_time": "2024-04-13T07:22:22",
"upload_time_iso_8601": "2024-04-13T07:22:22.140499Z",
"url": "https://files.pythonhosted.org/packages/1f/b4/df801bdef7169f799f6e7ac66a40c0d03b37dc7bf9399dfbc89d734012e8/kidash-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 07:22:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaoss",
"github_project": "grimoirelab-kidash",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kidash"
}
JSON
