Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.22 KB

README.md

File metadata and controls

69 lines (45 loc) · 2.22 KB

perceval-zulip Build Status Coverage Status PyPI version

Bundle of Perceval backends for Zulip.

Backends

The backends currently managed by this package support the next repositories:

  • Zulip

Requirements

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

Installation

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.

Installation and configuration

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

$ poetry install

Activate the virtual environment

$ poetry shell

Examples

Zulip

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

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.

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.