https://github.com/chaoss/grimoirelab-kidash

Kidash: A GrimoireLab tool & library to manage Kibana/Kibiter visualizations and dashboards

https://github.com/chaoss/grimoirelab-kidash

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords from Contributors

orchestration grimoirelab software-analytics data-enrichment archival projection community interactive generic sequences
Last synced: 10 months ago · JSON representation

Repository

Kidash: A GrimoireLab tool & library to manage Kibana/Kibiter visualizations and dashboards

Basic Info
  • Host: GitHub
  • Owner: chaoss
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Size: 406 KB
Statistics
  • Stars: 12
  • Watchers: 11
  • Forks: 61
  • Open Issues: 4
  • Releases: 0
Created over 8 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License Authors

README.md

Kidash Build Status Coverage Status PyPI version

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: 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.

Owner

  • Name: CHAOSS
  • Login: chaoss
  • Kind: organization

GitHub Events

Total
  • Release event: 13
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 1
  • Push event: 15
  • Pull request review event: 1
  • Pull request event: 2
  • Fork event: 3
  • Create event: 15
Last Year
  • Release event: 13
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 1
  • Push event: 15
  • Pull request review event: 1
  • Pull request event: 2
  • Fork event: 3
  • Create event: 15

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 219
  • Total Committers: 9
  • Avg Commits per committer: 24.333
  • Development Distribution Score (DDS): 0.507
Past Year
  • Commits: 41
  • Committers: 2
  • Avg Commits per committer: 20.5
  • Development Distribution Score (DDS): 0.341
Top Committers
Name Email Commits
Santiago Dueñas s****s@b****m 108
Jose Javier Merchante j****e@b****m 46
Alvaro del Castillo a****s@b****m 23
Valerio Cosentino v****s@b****m 16
alpgarcia a****a@b****m 8
Venu Vardhan Reddy Tekula v****u@c****y 7
Jesus M. Gonzalez-Barahona j****b@g****s 6
Quan Zhou q****n@b****m 4
dependabot[bot] 4****] 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 14
  • Total pull requests: 54
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 27 days
  • Total issue authors: 10
  • Total pull request authors: 9
  • Average comments per issue: 3.29
  • Average comments per pull request: 1.09
  • Merged pull requests: 45
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 0
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 15 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • GeorgLink (3)
  • jsmanrique (2)
  • valeriocos (2)
  • mafesan (1)
  • xiao623 (1)
  • acs (1)
  • marcofranssen (1)
  • luchiago (1)
  • jgbarah (1)
  • yodayuuki55 (1)
Pull Request Authors
  • jjmerchante (19)
  • valeriocos (13)
  • acs (9)
  • vchrombie (5)
  • alpgarcia (5)
  • sduenas (3)
  • dependabot[bot] (2)
  • zhquan (2)
  • jgbarah (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (2) bug (1) enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,747 last-month
  • Total docker downloads: 69
  • Total dependent packages: 2
  • Total dependent repositories: 11
  • Total versions: 102
  • Total maintainers: 2
pypi.org: kidash

GrimoireLab script to manage Kibana dashboards from the command line

  • Versions: 102
  • Dependent Packages: 2
  • Dependent Repositories: 11
  • Downloads: 1,747 Last month
  • Docker Downloads: 69
Rankings
Docker downloads count: 2.9%
Dependent packages count: 3.1%
Dependent repos count: 4.4%
Forks count: 5.6%
Average: 6.8%
Downloads: 8.3%
Stargazers count: 16.5%
Maintainers (2)
Last synced: 11 months ago

Dependencies

poetry.lock pypi
  • coverage 6.3.2 develop
  • flake8 4.0.1 develop
  • importlib-metadata 4.2.0 develop
  • mccabe 0.6.1 develop
  • pycodestyle 2.8.0 develop
  • pyflakes 2.4.0 develop
  • typing-extensions 4.1.1 develop
  • zipp 3.7.0 develop
  • certifi 2021.10.8
  • charset-normalizer 2.0.12
  • idna 3.3
  • python-dateutil 2.8.2
  • requests 2.26.0
  • six 1.16.0
  • urllib3 1.26.5
pyproject.toml pypi
  • coverage ^6.3.2 develop
  • flake8 ^4.0.1 develop
  • python ^3.7
  • python-dateutil ^2.8.2
  • requests 2.26.0
  • urllib3 1.26.5
.github/workflows/changelog.yml actions
  • bitergia/release-tools-check-changelog master composite
.github/workflows/release.yml actions
  • actions/checkout 93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 composite
  • actions/download-artifact fb598a63ae348fa914e94cd0ff38f362e927b741 composite
  • actions/setup-python 13ae5bb136fac2878aff31522b9efb785519f984 composite
  • chaoss/grimoirelab-github-actions/build master composite
  • chaoss/grimoirelab-github-actions/publish master composite
  • chaoss/grimoirelab-github-actions/release master composite
.github/workflows/tests.yml actions
  • actions/checkout 93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 composite
  • actions/setup-python 13ae5bb136fac2878aff31522b9efb785519f984 composite