Google Git
Sign in
apache / kibble-scanners / 9b29ce29e52292f190d1e35fc9b5ab8f46d3f90a
commit9b29ce29e52292f190d1e35fc9b5ab8f46d3f90a[log] [tgz]
authorDaniel Gruno <humbedooh@apache.org>Sat Oct 21 11:18:17 2017 +0200
committerDaniel Gruno <humbedooh@apache.org>Sat Oct 21 11:18:17 2017 +0200
tree50f4c41c72b21f320c78911acc70b5eab9bdd5c9
parent457b0a6ae529db40472b3f28520cab59cb2f5185 [diff]
start working on a contributing doc
1 file changed
tree: 50f4c41c72b21f320c78911acc70b5eab9bdd5c9
  1. conf/
  2. src/
  3. CONDUCT.md
  4. CONTRIBUTING.md
  5. LICENSE
  6. mapping.json
  7. README.md
  8. requirements.txt
README.md

Kibble Scanner Application

The Kibble Scanners collect information for the Kibble Suite.

Setup instructions:

  • Edit conf/config.yaml to match your Kibble service

How to run:

  • On a daily/weekly/whatever basis, run: python3 src/kibble-scanner.py.

Directory structure:

  • conf/: Config files
  • src/:
    • kibble-scanner.py: Main script for launching scans
    • plugins/:
      • brokers: The various database brokers (ES or JSON API)
      • utils: Utility libraries
      • scanners: The individual scanner applications

Currently available scanner plugins:

  • Apache Pony Mail (plugins/scanners/ponymail.py)
  • Atlassian JIRA (plugins/scanners/jira.py)
  • BugZilla Issue Tracker (plugins/scanners/bugzilla.py)
  • Gerrit Code Review (plugins/scanners/gerrit.py)
  • Git Repository Fetcher (plugins/scanners/git-sync.py)
  • Git Census Counter (plugins/scanners/git-census.py)
  • Git Code Evolution Counter (plugins/scanners/git-evolution.py)
  • Git SLoC Counter (plugins/scanners/git-sloc.py)
  • GitHub Issues/PRs (plugins/scanners/github.py)
  • GitHub Traffic Statistics (plugins/scanners/github-stats.py)
  • GNU Mailman Pipermail (plugins/scanners/pipermail.py)

Requirements:

  • cloc version 1.70 or later
  • git binaries
  • python3 (3.3 or later)
  • python3-elasticsearch
  • python3-dateutils

Get involved

TBD. Please see https://kibble.apache.org/ for details!