https://github.com/chronicle-app/chronicle-zulip
Zulip importer for chronicle-etl
https://github.com/chronicle-app/chronicle-zulip
archiving chronicle-etl chronicle-plugin data-liberation memex personal-archive personal-data zulip zulip-api
Last synced: about 2 months ago
JSON representation
Zulip importer for chronicle-etl
- Host: GitHub
- URL: https://github.com/chronicle-app/chronicle-zulip
- Owner: chronicle-app
- Created: 2022-04-03T02:59:51.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-24T18:47:21.000Z (about 3 years ago)
- Last Synced: 2025-02-13T12:43:33.908Z (2 months ago)
- Topics: archiving, chronicle-etl, chronicle-plugin, data-liberation, memex, personal-archive, personal-data, zulip, zulip-api
- Language: Ruby
- Homepage:
- Size: 13.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Chronicle::Zulip
[](https://badge.fury.io/rb/chronicle-zulip)
Extract your Zulip messages using the command line with this plugin for [chronicle-etl](https://github.com/chronicle-app/chronicle-etl).
## Usage
```sh
# Install chronicle-etl and this plugin
$ gem install chronicle-etl
$ chronicle-etl plugins:install zulip
```
You can get a personal access token by going to Settings -> Account & Privacy and pressing the "Show/change your API key".
```sh
# Save username, access_token, and realm
$ chronicle-etl secrets:set zulip username [email protected]
$ chronicle-etl secrets:set zulip access_token ACCESS_TOKEN
$ chronicle-etl secrets:set zulip realm foo
# Then, retrieve your private messages
$ chronicle-etl --extractor zulip:private-message --loader json
```
## Available Connectors
### Extractors
#### `private-messages`
Extractor for importing private messages from Zulip
##### Settings
- `username`: The email address associated with your Zulip account
- `access_token`: Your personal access token
- `realm`: ____.zulipchat.com
### Transformers
#### `message`
Transform a Zulip message into Chronicle Schema