PartyBook is a Telegram bot designed to help users track their reading progress and receive excerpts from books they are currently reading. The bot allows users to manage their reading lists and get daily notifications with book excerpts.
- Track the current book and reading progress for each user.
- Send excerpts from the current reading position.
- Daily notifications at 20:20 for users who have enabled this feature.
- User-friendly commands for easy interaction.
You can find actual example here: https://telegram.me/PartyBook_bot
Before you begin, ensure you have met the following requirements:
- Python 3.x installed on your machine.
- A Telegram account to create and interact with the bot.
- Access to a database (e.g., SQLite, PostgreSQL) to store user data and book information.
-
Clone the repository:
git clone https://github.com/axtrace/PartyBook.git cd PartyBook -
Install the required dependencies:
pip install -r requirements.txt
-
Set up your Telegram bot:
- Create a new bot using BotFather on Telegram.
- Obtain your bot token.
-
Configure your database connection in the code.
-
Rename to "tokens.py", change tokens and IP in your local repo file token_example.py
-
Run the bot:
python telebot_handler.py --prod
Once the bot is running, you can interact with it using the following commands:
/start: Start interacting with the bot./help: Get a list of available commands./current: Check which book you are currently reading./set_progress <page_number>: Update your reading progress./daily_excerpts: Enable or disable daily excerpt notifications.
Contributions are welcome! If you have suggestions for improvements or find bugs, please open an issue or submit a pull request.
- Fork the repository.
- Create your feature branch (
git checkout -b feature/YourFeature). - Commit your changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/YourFeature). - Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.