Bot for fetching snippet descriptions for arxiv.org and summarizing papers

metya 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
.github 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
assets 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
conda 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
db 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
docker 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
scripts 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
src 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
.dockerignore 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
.gitattributes 3709695f77 feat: add database and summarizer 2 years ago
.gitignore 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
.pre-commit-config.yaml a68b0216ed ci(github-actions): add github actions 2 years ago
CHANGELOG.md 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
README.md 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago
pyproject.toml eea46e44a1 bump: version 1.0.2 → 1.0.3 2 years ago
requirements.txt 3709695f77 feat: add database and summarizer 2 years ago
vanitybot.py 6c96eee6fe 🔧 refactor: clean up everything with folder structures 2 years ago

README.md

arxiv-vanity-bot for telegram

Telegram for some reason doesn't show snippets for links from arxiv.org site. This bot created to get work around of this problem. It is useful to having this bot in chats where you can share links from arxiv and bot will replying on that messages with some kind of snippets with title and description of paper and link to mobile friendly service for arxiv papers - arxiv-vanity.com

Also there is functionality of get summary of a paper with short highlights and findings. It is useful to get familiar with main findings of a paper and decide to read or not :)

Ready to use bot: https://t.me/arxiv_vanity_bot

TODO

Sometime I implement the functionality of getting Figures from a paper, because pictures is very important to understand what's going on :)

Installation

git clone https://github.com/metya/vanity-bot

After that create file in the root of repository with name "token" and put there text below

API_TOKEN=your_bot_token

And after that just

docker compose up -d

or use environment variables with compose instead of token file

docker-compose run -d -e API_TOKEN=your_bot_token bot

Usage

Add your bot in chat where you discuss arxiv papers and enjoy. Or use my bot https://t.me/arxiv_vanity_bot

Illustration