This release is a pre-release and may not be stable for production use.
Kidash 
Kidash is a tool for managing Kibana-related dashboards from the command line. The standard GrimoireLab dashboards are available in the Sigils repository.
Requirements
- Python >= 3.10
You will also need some other libraries for running the tool, you can find the whole list of dependencies in 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 for dependency management and packaging. You can install it following its documentation. 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:
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:
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.
Release files for kidash 1.1.11rc1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| kidash-1.1.11rc1.tar.gz | 33.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kidash-1.1.11rc1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 61.9 kB
Release files / kidash-1.1.11rc1.tar.gz
| Download URL | kidash-1.1.11rc1.tar.gz |
|---|---|
| Size | 33.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
21646ff6cbdf991fb2195cf147944545c7daeb5cf456a0677725c9efd6a6dddf
|
|
BLAKE2b-256 checksum How to use checksums |
81008dbbf3e1d080fa1aff48a8b70dd6150fec9c5fbf94c9bbe3f382dd77bbbe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.12.3 Linux/6.17.0-1022-azure
|
Release files / kidash-1.1.11rc1-py3-none-any.whl
| Download URL | kidash-1.1.11rc1-py3-none-any.whl |
|---|---|
| Size | 28.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b4adf7defc7906f3baf2453170a5d26169430be5c008b1de370166f7c301d9d
|
|
BLAKE2b-256 checksum How to use checksums |
2f3bcb5a4525a4b0db4d67002f982a69477b1d6ac4415885be8dc3fb1aae4620
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.12.3 Linux/6.17.0-1022-azure
|
