grimoirelab-chronicler 1.0.0a1

Generator of GrimoireLab events using Perceval data.

Chronicler

Tool and library to convert Perceval data into events.

Usage

$ chronicler --help
Usage: chronicler [OPTIONS] DATASOURCE

Generates GrimoireLab events from the items obtained by Perceval.

The chronicler is a command line tool and a library that converts items
generated by Perceval into events. The tool reads these events from the
standard input or from a given file.

To run it, you will have to give the type of items the chronicler is
receiving with DATASOURCE argument (e.g. git, github, gitlab).

Output is produced using JSON format. Use the option <json_line>
to generate JSON object per line.

Options:
  --input FILENAME   File with perceval items
  --output FILENAME  File where events will be written
  --json-line        Produce a JSON line for each output item
  --version          Show the version and exit.
  --help             Show this message and exit.

You can connect the Chronicler with Perceval to generate events.

perceval git --json-line https://example.com | chronicler git

Installation

There are several methods to install this tool.

pip

pip install grimoirelab-chronicler

poetry (source code)

We use poetry for dependency management and packaging. You can install chronicler and its dependencies on an isolated environment provided by poetry.

poetry install
poetry shell

Contributing

Chronicler is part of the GrimoireLab project. Please read its Contributing Guidelines for more information.