# perceval-zulip
[](https://github.com/vchrombie/grimoirelab-perceval-zulip/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/vchrombie/grimoirelab-perceval-zulip?branch=master) [](https://badge.fury.io/py/perceval-zulip)
Perceval backend for Zulip.
## Requirements
* Python >= 3.8
* python3-requests >= 2.7
* grimoirelab-toolkit >= 0.3, <1.1
* perceval >= 1.0.2, <1.1
## Prerequisites
### Poetry
We use [Poetry](https://python-poetry.org/docs/) for managing the project.
You can install it following [these steps](https://python-poetry.org/docs/#installation).
## Installation
### 1. PyPI
Perceval Zulip backend can be installed using [pip](https://pip.pypa.io/en/stable/)
It is advised to use a [virtual environment](https://docs.python.org/3/tutorial/venv.html)
```
(.venv) $ pip install perceval-zulip
```
### 2. Getting the source code
Clone the repository
```
$ git clone https://github.com/vchrombie/grimoirelab-perceval-zulip perceval-zulip
$ cd perceval-zulip
```
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` (API key) from the server. You can use the user email and API key
for authentication or create a bot and use the bot email and API key.
Reference: [About bots (Zulip Help Center)](https://zulip.com/help/bots-and-integrations).
```
(.venv) $ perceval zulip --help
[2021-09-20 15:57:22,523] - 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
authentication arguments:
-t API_TOKEN, --api-token API_TOKEN
backend authentication token / API key
zulip arguments:
-e EMAIL, --email EMAIL
Zulip bot/user email
```
Fetch messages from the `importlib` stream of the [Python Zulip Server](https://python.zulipchat.com) with the
bot email `bot@zulipchat.com` and API key `xxxx`
```
(.venv) $ perceval zulip https://python.zulipchat.com importlib -e bot@zulipchat.com -t xxxx
[2021-09-20 15:59:24,593] - Sir Perceval is on his quest.
{
...
```
## Contributing
This project follows the [contributing guidelines](https://github.com/chaoss/grimoirelab/blob/master/CONTRIBUTING.md)
of the GrimoireLab.
## Acknowledgment
The backend was initially developed by [@vchrombie](https://github.com/vchrombie).
Adhering to the guidelines, the work is started in this external repository. But, this can be merged
([chaoss/grimoirelab-perceval/#/667](https://github.com/chaoss/grimoirelab-perceval/pull/667)) into the
[Perceval](https://github.com/chaoss/grimoirelab-perceval) repository in the future.
## License
Licensed under GNU General Public License (GPL), version 3 or later.
Raw data
{
"_id": null,
"home_page": "https://chaoss.github.io/grimoirelab/",
"name": "perceval-zulip",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "development, grimoirelab",
"author": "GrimoireLab Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/90/32/375701511bde564b7e926533c218abc4b77dd4a888e0f3419d930d22d7da/perceval_zulip-0.3.0.tar.gz",
"platform": null,
"description": "# perceval-zulip\n[](https://github.com/vchrombie/grimoirelab-perceval-zulip/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/vchrombie/grimoirelab-perceval-zulip?branch=master) [](https://badge.fury.io/py/perceval-zulip)\n\nPerceval backend for Zulip.\n\n\n## Requirements\n\n* Python >= 3.8\n* python3-requests >= 2.7\n* grimoirelab-toolkit >= 0.3, <1.1\n* perceval >= 1.0.2, <1.1\n\n## Prerequisites\n\n### Poetry\n\nWe use [Poetry](https://python-poetry.org/docs/) for managing the project.\nYou can install it following [these steps](https://python-poetry.org/docs/#installation).\n\n\n## Installation\n\n### 1. PyPI\n\nPerceval Zulip backend can be installed using [pip](https://pip.pypa.io/en/stable/)\n\nIt is advised to use a [virtual environment](https://docs.python.org/3/tutorial/venv.html)\n```\n(.venv) $ pip install perceval-zulip\n```\n\n### 2. Getting the source code\n\nClone the repository\n```\n$ git clone https://github.com/vchrombie/grimoirelab-perceval-zulip perceval-zulip\n$ cd perceval-zulip\n```\n\nInstall the required dependencies (this will also create a virtual environment)\n```\n$ poetry install\n```\n\nActivate the virtual environment\n```\n$ poetry shell\n```\n\n\n## Usage\n\n**Note:** You need the `email` and the `api_token` (API key) from the server. You can use the user email and API key\nfor authentication or create a bot and use the bot email and API key.\n\nReference: [About bots (Zulip Help Center)](https://zulip.com/help/bots-and-integrations).\n```\n(.venv) $ perceval zulip --help\n[2021-09-20 15:57:22,523] - Sir Perceval is on his quest.\nusage: perceval [-h] [--category CATEGORY] [--tag TAG] [--filter-classified] -t API_TOKEN\n [--archive-path ARCHIVE_PATH] [--no-archive] [--fetch-archive]\n [--archived-since ARCHIVED_SINCE] [--no-ssl-verify] [-o OUTFILE]\n [--json-line] -e EMAIL\n url stream\n\npositional arguments:\n url Zulip chat URL\n stream Zulip chat stream name\n\noptional arguments:\n -h, --help show this help message and exit\n\nauthentication arguments:\n -t API_TOKEN, --api-token API_TOKEN\n backend authentication token / API key\n\nzulip arguments:\n -e EMAIL, --email EMAIL\n Zulip bot/user email\n```\n\nFetch messages from the `importlib` stream of the [Python Zulip Server](https://python.zulipchat.com) with the\nbot email `bot@zulipchat.com` and API key `xxxx`\n```\n(.venv) $ perceval zulip https://python.zulipchat.com importlib -e bot@zulipchat.com -t xxxx\n[2021-09-20 15:59:24,593] - Sir Perceval is on his quest.\n{\n...\n```\n\n\n## Contributing\n\nThis project follows the [contributing guidelines](https://github.com/chaoss/grimoirelab/blob/master/CONTRIBUTING.md)\nof the GrimoireLab.\n\n\n## Acknowledgment\n\nThe backend was initially developed by [@vchrombie](https://github.com/vchrombie).\n\nAdhering to the guidelines, the work is started in this external repository. But, this can be merged\n([chaoss/grimoirelab-perceval/#/667](https://github.com/chaoss/grimoirelab-perceval/pull/667)) into the \n[Perceval](https://github.com/chaoss/grimoirelab-perceval) repository in the future.\n\n\n## License\n\nLicensed under GNU General Public License (GPL), version 3 or later.\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "Perceval backend for Zulip.",
"version": "0.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/vchrombie/grimoirelab-perceval-zulip/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/vchrombie/grimoirelab-perceval-zulip"
},
"split_keywords": [
"development",
" grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c65de7aa72cea2aacdec4002fe63486f43fa25b5894b69169fe8d0a279b4920e",
"md5": "b4d509e9472a898605416a7f8a1d7c49",
"sha256": "230861f2f1bc41c517676f8cc4abab02c34d3dabc28aae11426b2c894f67d6cf"
},
"downloads": -1,
"filename": "perceval_zulip-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4d509e9472a898605416a7f8a1d7c49",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 18048,
"upload_time": "2024-07-06T16:29:07",
"upload_time_iso_8601": "2024-07-06T16:29:07.286545Z",
"url": "https://files.pythonhosted.org/packages/c6/5d/e7aa72cea2aacdec4002fe63486f43fa25b5894b69169fe8d0a279b4920e/perceval_zulip-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9032375701511bde564b7e926533c218abc4b77dd4a888e0f3419d930d22d7da",
"md5": "ab970f74f5beadf0cbbfbda90e74fda4",
"sha256": "e3adc16ff4f86f6b80cf98ea598207016c0168ecd746f23af3e494512a8ff704"
},
"downloads": -1,
"filename": "perceval_zulip-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "ab970f74f5beadf0cbbfbda90e74fda4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 21367,
"upload_time": "2024-07-06T16:29:08",
"upload_time_iso_8601": "2024-07-06T16:29:08.723804Z",
"url": "https://files.pythonhosted.org/packages/90/32/375701511bde564b7e926533c218abc4b77dd4a888e0f3419d930d22d7da/perceval_zulip-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-06 16:29:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vchrombie",
"github_project": "grimoirelab-perceval-zulip",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "perceval-zulip"
}
JSON
