mirror of
https://github.com/run-llama/llama-hub.git
synced 2025-08-15 04:01:32 +00:00
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
|
## 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"
|
||
|
|
```
|
||
|
|
|
||
|
|
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.
|