Giter Club home page Giter Club logo

book-bot's Introduction

BookBuddy - телеграм бот для удобного чтения книг

Этот Telegram-бот позволяет добавлять и удалять книги из собственной библиотеки, а также читать их в удобном виде. Изначально в библиотеке есть одна встроенная книга Рэя Брэдбери "Марсианские Хроники".

Чтобы добавить собственную книгу, нужно отправить её в чат в виде текстового файла (.txt).

Читая книгу можно добавлять закладки, нажимая на кнопку текущей страницы. Закладки видны только у текущей книги, чтобы увидеть закладки другой книги, надо начать её читать.

Команды:

  • /start - запустить бота.
  • /help - справка по использованию.
  • /continue - продолжить чтение.
  • /books - список книг библиотеки.
  • /bookmarks - список закладок.

Бот использует базу данных PostgreeSQL для хранения своих фраз, книг, команд и пользователей.

Зависимости

Python 3.8+
aiogram 3.0.* - для использования Telegram Bot API
psycopg2 2.9.6 - работа с базой данных
python-dotenv 1.0.0 - переменные окружения
requests 2.31.0 - запросы к апи телеграмма

Установка

  1. Клонирование репозитория:
git clone https://github.com/MaximGudkov/BookBot.git
  1. Создание виртуального окружения и установка зависимостей:
python3.8 -m venv env
source env/bin/activate
pip install -r requirements.txt
  1. Заполнить файл .env.example и переименовать его .env.

  2. Запуск бота. python bot.py

Полезности

  • Обратите внимание, что при каждом запуске бота стираются все данные из базы данных (если были) и заполняются необходимые для работы бота таблицы, это свзано с запуском функции setup_db, которую я создал для удобного создания и заполнения необходимых таблиц. Если при очередном запуске необходимо сохранить данные, следует закомментировать функцию setup_db bot.py
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/

book-bot's People

Contributors

maximgudkov avatar

Stargazers

 avatar Dmitry Shchutsky avatar J.P avatar Artemy avatar Maksim avatar jist avatar  avatar Denis Gudkov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.