| Name | llama-index-readers-zulip JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | llama-index readers zulip integration |
| upload_time | 2024-08-22 07:15:14 |
| maintainer | plurigrid |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.8.1 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Zulip Loader
The Zulip Loader is a Python script that allows you to load data from Zulip streams using a Zulip bot's API token. It fetches messages from specified streams or all streams if none are specified, and returns a list of documents with the stream content.
### Prerequisites
Create a Zulip bot and obtain its API token. Follow the instructions in the Zulip documentation to create a bot and get the API key (token).
Set the ZULIP_TOKEN environment variable to your Zulip bot's API token:
```bash
export ZULIP_TOKEN="your-zulip-bot-api-token"
```
### Installation
You can install the Zulip Reader via pip:
```bash
pip install llama-index-readers-zulip
```
### Usage
Use the ZulipReader class to load data from Zulip streams:
```python
from zulip_loader import ZulipReader
# Initialize the ZulipReader with the bot's email and Zulip domain
reader = ZulipReader(
zulip_email="your-bot-email@your-zulip-domain.zulipchat.com",
zulip_domain="your-zulip-domain.zulipchat.com",
)
# Load data from all streams
data = reader.load_data(reader.get_all_streams())
# Load data from specific streams
stream_names = ["stream1", "stream2"]
data = reader.load_data(stream_names)
# This will return a list of documents containing the content of the specified streams.
```
For more customization, you can pass the `reverse_chronological` parameter to the load_data() method to indicate the order of messages in the output.
This loader is designed to be used as a way to load data into
[LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently
used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-zulip",
"maintainer": "plurigrid",
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/c1/6f/2d01b5adad2d2eaab26150877d9fe9e90e6f86e76e35ca3235c91b88b17c/llama_index_readers_zulip-0.2.0.tar.gz",
"platform": null,
"description": "## Zulip Loader\n\nThe Zulip Loader is a Python script that allows you to load data from Zulip streams using a Zulip bot's API token. It fetches messages from specified streams or all streams if none are specified, and returns a list of documents with the stream content.\n\n### Prerequisites\n\nCreate a Zulip bot and obtain its API token. Follow the instructions in the Zulip documentation to create a bot and get the API key (token).\n\nSet the ZULIP_TOKEN environment variable to your Zulip bot's API token:\n\n```bash\nexport ZULIP_TOKEN=\"your-zulip-bot-api-token\"\n```\n\n### Installation\n\nYou can install the Zulip Reader via pip:\n\n```bash\npip install llama-index-readers-zulip\n```\n\n### Usage\n\nUse the ZulipReader class to load data from Zulip streams:\n\n```python\nfrom zulip_loader import ZulipReader\n\n# Initialize the ZulipReader with the bot's email and Zulip domain\nreader = ZulipReader(\n zulip_email=\"your-bot-email@your-zulip-domain.zulipchat.com\",\n zulip_domain=\"your-zulip-domain.zulipchat.com\",\n)\n\n# Load data from all streams\ndata = reader.load_data(reader.get_all_streams())\n\n# Load data from specific streams\nstream_names = [\"stream1\", \"stream2\"]\ndata = reader.load_data(stream_names)\n# This will return a list of documents containing the content of the specified streams.\n```\n\nFor more customization, you can pass the `reverse_chronological` parameter to the load_data() method to indicate the order of messages in the output.\n\nThis loader is designed to be used as a way to load data into\n[LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently\nused as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers zulip integration",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "46ca0e52cee6bb5c75c9003005d551ec86343fba351fdcd1d57b42405f5343ea",
"md5": "b237ab39ebaaa08dc3bfb23e5268fd04",
"sha256": "55084903b34e93953bce54c819b7a4b7502ad0f1517860641ced0e9522788fe5"
},
"downloads": -1,
"filename": "llama_index_readers_zulip-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b237ab39ebaaa08dc3bfb23e5268fd04",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 3180,
"upload_time": "2024-08-22T07:15:14",
"upload_time_iso_8601": "2024-08-22T07:15:14.106549Z",
"url": "https://files.pythonhosted.org/packages/46/ca/0e52cee6bb5c75c9003005d551ec86343fba351fdcd1d57b42405f5343ea/llama_index_readers_zulip-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c16f2d01b5adad2d2eaab26150877d9fe9e90e6f86e76e35ca3235c91b88b17c",
"md5": "3d23bde3d30ba60e119b772bfbd04e4c",
"sha256": "ca1925fe5f62ad2ff6704bc6d06c9b5ddee5e4dbf819f95e99e3e6c0145d3b7d"
},
"downloads": -1,
"filename": "llama_index_readers_zulip-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "3d23bde3d30ba60e119b772bfbd04e4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 2942,
"upload_time": "2024-08-22T07:15:14",
"upload_time_iso_8601": "2024-08-22T07:15:14.920325Z",
"url": "https://files.pythonhosted.org/packages/c1/6f/2d01b5adad2d2eaab26150877d9fe9e90e6f86e76e35ca3235c91b88b17c/llama_index_readers_zulip-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 07:15:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-zulip"
}
