Skip to content

Patch 4 #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VladimirShitov merged 3 commits into from
Aug 19, 2025
Merged

Patch 4 #35

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8504987
Update README.md
javier-marchena-hurtado Aug 19, 2025
6fed4dc
Update README.md
javier-marchena-hurtado Aug 19, 2025
0e929d5
Set `is_posting` to true in mattermost example
VladimirShitov Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Currently supported platforms:

PaperBee queries scientific papers using user-specified keywords from PubMed and preprint services, relying on the [findpapers](https://github.com/jonatasgrosman/findpapers/) library.
Papers are then filtered either **manually via a command-line interface** or **automatically via an LLM**.
The filtered papers are posted to a Google Sheet and, if desired, to Slack, Telegram, or Zulip channels.
The filtered papers are posted to a Google Sheet and, if desired, to Slack, Telegram, Zulip or Mattermost channels.
PaperBee is easy to setup and configure with a simple `yml` file.

---
Expand Down Expand Up @@ -63,7 +63,7 @@ PaperBee uses the NCBI API to fetch papers and DOIs from PubMed.

### 3. 📢 Setup Posting Channels

> **You must set up at least one of the three platforms below.**
> **You must set up at least one of the four platforms below.**

#### 🟣 Slack (optional)

Expand Down Expand Up @@ -176,6 +176,14 @@ ZULIP:
stream: "your-zulip-stream"
topic: "your-zulip-topic"

# Mattermost configuration
MATTERMOST:
is_posting_on: true
url: "your-mattermost-url" # e.g. mattermost.example.com (do NOT include https://)
token: "your-mattermost-token"
team: "your-mattermost-team-name" # The team name (not display name)
channel: "your-channel-name" # The channel name (not display name)

SLACK_TEST_CHANNEL_ID: "your-slack-test-channel-id" # not required so left outside of dictionary
TELEGRAM_TEST_CHANNEL_ID: "your-slack-test-channel-id" # not required so left outside of dictionary
GOOGLE_TEST_SPREADSHEET_ID: "your-google-test-spreadsheet-id" # not required so left outside of dictionary
Expand Down