https://github.com/antonvagabond/bookbot
Telegram bot for reading books.
https://github.com/antonvagabond/bookbot
aiogram aiogram-bot asincio psycopg2 python python3
Last synced: 5 days ago
JSON representation
Telegram bot for reading books.
- Host: GitHub
- URL: https://github.com/antonvagabond/bookbot
- Owner: AntonVagabond
- Created: 2023-08-22T13:08:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-19T08:47:21.000Z (over 2 years ago)
- Last Synced: 2025-01-08T10:45:59.529Z (over 1 year ago)
- Topics: aiogram, aiogram-bot, asincio, psycopg2, python, python3
- Language: Python
- Homepage:
- Size: 1.65 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BookBot - телеграм бот для удобного чтения книг
Этот Telegram-бот позволяет добавлять и удалять книги из собственной библиотеки, а также читать их в удобном виде. Изначально в библиотеке есть одна встроенная книга Рэя Брэдбери "Марсианские Хроники". Чтобы добавить собственную книгу, нужно отправить её в чат в виде текстового файла (.txt).
Читая книгу можно добавлять закладки, нажимая на кнопку текущей страницы. Закладки видны только у текущей книги, чтобы увидеть закладки другой книги, надо начать её читать.
**Команды**:
- `/start` - запустить бота.
- `/help` - справка по использованию.
- `/continue` - продолжить чтение.
- `/books` - список книг библиотеки.
- `/bookmarks` - список закладок.
Бот использует базу данных PostgreSQL для хранения своих фраз, книг, команд и пользователей.
# Зависимости
Python 3.8+
aiogram 3.0.* - для использования Telegram Bot API
psycopg2 2.9.6+ - работа с базой данных
python-dotenv 1.0.0 - переменные окружения
requests 2.31.0 - запросы к апи телеграмма
# Установка
1. Клонирование репозитория:
```bash
git clone https://github.com/AntonVagabond/Bookbot.git
```
2. Создание виртуального окружения и установка зависимостей:
```bash
python3.8 -m venv env
source env/bin/activate
pip install -r requirements.txt
```
3. Заполнить файл `.env.example` и переименовать его `.env`.
4. Запуск бота.
```python bot.py```
# Полезности
- Обратите внимание, что при каждом запуске бота стираются все данные из базы данных (если были) и заполняются необходимые для работы бота таблицы, это свзано с запуском функции setup_db, которую я создал для удобного создания и заполнения необходимых таблиц. Если при очередном запуске необходимо сохранить данные, следует закомментировать функцию setup_db
bot.py
```pycon
python bot.py
def main():
...
# WARNING: This will delete all existing tables and will
# re-fill the data for the bot's lexicon. See docstring
setup_db()
...
```
- Чтобы протестировать бота, прикрепляю несколько книг в директорию books/