MyDigest

A news aggregator bot that provides users with personalized, concise daily digests from selected Telegram channels. The service focuses on delivering relevant news content through advanced recommendation systems, offering a minimalistic and ad-free user experience with the option to navigate to the original source.

Features

📰 Aggregate news from multiple Telegram channels
🛠️ Create and manage custom digests.
📬 Schedule digests to be sent at specific times.
🔎 Search news by keywords or categories.
📊 Store and analyze user preferences for personalized recommendations.

Get started

Clone the Repository:

git clone https://github.com/SimulatorML/MyDigest
cd MyDigest

Setup with Makefile (recommended):

make setup
source mydigest/bin/activate # On Windows use: mydigest\Scripts\activate
make run

Or manual setup with venv:

python -m venv venv
source venv/bin/activate  # On Windows use: venv\Scripts\activate
pip install -r requirements.txt
python -m src.bot

Development

Adding a New Feature

Create a new branch:
```
git checkout -b username/feature-name
```
Implement your changes in the appropriate module.
Puch to origin
```
git push origin username/feature-name
```
Submit a merge request for review.

Docker run

Create an .env file with environment variables in the root of the repository using the .env.sample template.
Create a dev_scripts/docker_build.sh file using the dev_scripts/sample.docker_build.sh template.
Create a dev_scripts/docker_run.sh file using the dev_scripts/sample.docker_run.sh template.

Run the build command
```
sh ./dev_scripts/docker_build.sh
```
Run the docker launch command
```
sh ./dev_scripts/docker_run.sh
```
Use the deployed Bot

Project structure

data - данные для работы с ботом
dev_scripts - скрипты для локальной cборки и запуска сервиса в докер контейнере
notebooks - jupyter notebooks для экспериментов/тестов/примеров
src - код проекта
test - тесты