Metadata-Version: 2.1
Name: kidash
Version: 0.5.1
Summary: GrimoireLab script to manage Kibana dashboards from the command line
Home-page: https://chaoss.github.io/grimoirelab/
License: GPL-3.0+
Keywords: development,grimoirelab
Author: GrimoireLab Developers
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Requires-Dist: certifi (==2022.9.24)
Requires-Dist: charset-normalizer (==2.1.1)
Requires-Dist: idna (==3.4)
Requires-Dist: python-dateutil (==2.8.2)
Requires-Dist: requests (==2.28.1)
Requires-Dist: six (==1.16.0)
Requires-Dist: urllib3 (==1.26.12)
Project-URL: Bug Tracker, https://github.com/chaoss/grimoirelab-kidash/issues
Project-URL: Repository, https://github.com/chaoss/grimoirelab-kidash
Description-Content-Type: text/markdown

# Kidash [![Build Status](https://github.com/chaoss/grimoirelab-kidash/workflows/tests/badge.svg)](https://github.com/chaoss/grimoirelab-kidash/actions?query=workflow:tests+branch:master+event:push) [![Coverage Status](https://img.shields.io/coveralls/chaoss/grimoirelab-kidash.svg)](https://coveralls.io/r/chaoss/grimoirelab-kidash?branch=master)

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.

## Installation

You can set up a virtual environment where Kidash will be installed
```
python3 -m venv foo
source bin foo/bin/activate
```

* Using PyPi
```buildoutcfg
pip3 install kidash
```

* From Source code
```buildoutcfg
git clone https://github.com/chaoss/grimoirelab-kidash
cd grimoirelab-kidash
python3 setup.py install
```

## 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
```

