drumsergio/askepub repository overview

⁠AskePub

Telegram bot assistant to help you prepare ePubs. Uses ChatGPT-4o to write contextual notes.

⁠Features

• Upload any .epub file via Telegram
• Select specific chapters or study the entire book
• Customize up to 10 study questions (or use smart defaults)
• Get three output formats:
  • Annotated ePub with study notes injected into each chapter
  • Word document (.docx) with all notes organized by chapter
  • PDF with the same content
• Multi-language support (English, Spanish, Italian, French, German, Portuguese, Bulgarian)
• User access control via whitelist
• Rate limiting to manage API costs
• Admin notification and broadcast system

⁠Install

⁠Docker (recommended)

docker run --name askepub \
  -e TOKEN=your-telegram-bot-token \
  -e OPENAI_API_KEY=your-openai-key \
  -e ADMIN_ID=your-telegram-user-id \
  -e USER_IDS=id1,id2,id3 \
  -v askepub-dbs:/app/dbs \
  -v askepub-backups:/app/userBackups \
  drumsergio/askepub:2.0.0

⁠Docker Compose

docker compose up -d

See docker-compose.yml⁠ for the full configuration.

⁠Environment Variables

⁠Usage

1. Start a chat with your bot on Telegram
2. Send /start
3. Select your language
4. Upload an .epub file
5. Choose which chapters to study
6. Customize your study questions (or use defaults)
7. Wait for the AI to generate notes
8. Download your annotated ePub, DOCX, and PDF

⁠Commands

• /start - Start the bot and begin a study session
• /change_language - Change your interface language
• /cancel - Cancel the current operation

⁠Maintainers

@GeiserX⁠

⁠Contributing

Feel free to dive in! Open an issue⁠ or submit PRs.

AskePub follows the Contributor Covenant⁠ Code of Conduct.

⁠Related Projects

ePub Tools:

• ePubLangMerger⁠ — Merge two ePubs into a bilingual parallel reading book
• epub-and-vtt-to-llm⁠ — Fine-tune LLMs from ePub and subtitle data

Telegram Bots:

• Telegram-Archive⁠ — Automated Telegram backup with local web viewer
• paperless-telegram-bot⁠ — Manage Paperless-NGX documents through Telegram
• telegram-delay-channel-cloner⁠ — Relay messages between channels with delay
• jellyfin-telegram-channel-sync⁠ — Sync Jellyfin access with Telegram membership
• telegram-slskd-local-bot⁠ — Automated music discovery and download via Telegram

⁠License

MIT⁠