perceval-zulip

Perceval backend for Zulip.

Requirements

• Python >= 3.6.1
• python3-requests >= 2.7
• grimoirelab-toolkit >= 0.2
• perceval >= 0.17.4

Installation

1. PyPI

Perceval Zulip backend can be installed using pip

$ pip install perceval-zulip

2. Getting the source code

Clone the repository

$ git clone https://github.com/vchrombie/grimoirelab-perceval-zulip

Prerequisites

Poetry

We use Poetry for managing the project. You can install it following these steps.

Setup

Install the required dependencies (this will also create a virtual environment)

$ poetry install

Activate the virtual environment

$ poetry shell

Usage

Note: You need the email and the api_token from the server. You can create a bot and use it for the authentication, please read the docs at About bots (Zulip Help Center).

$ perceval zulip --help
[2021-09-11 12:50:28,594] - Sir Perceval is on his quest.
usage: perceval [-h] [--category CATEGORY] [--tag TAG] [--filter-classified] -t API_TOKEN
                [--archive-path ARCHIVE_PATH] [--no-archive] [--fetch-archive]
                [--archived-since ARCHIVED_SINCE] [--no-ssl-verify] [-o OUTFILE]
                [--json-line] [-e EMAIL]
                url stream

positional arguments:
  url                   Zulip chat URL
  stream                Zulip chat stream name

optional arguments:
  -h, --help            show this help message and exit
  -e EMAIL, --email EMAIL
                        Zulip bot email

authentication arguments:
  -t API_TOKEN, --api-token API_TOKEN
                        backend authentication token / API key

Fetch messages from the importlib stream of the Python Zulip Server

$ perceval zulip https://python.zulipchat.com importlib -e bot@zulipchat.com -t xxxx

Contributing

This project follows the contributing guidelines of the GrimoireLab.

Acknowledgment

The backend was initially developed by @vchrombie.

Adhering to the guidelines, the work is started in this external repository. But, this can be merged (chaoss/grimoirelab-perceval/#/667) into the Perceval repository in the future.

License

Licensed under GNU General Public License (GPL), version 3 or later.