Skip to content

Commit 53598dc

Browse files
committed
Update pylint configuration and README; add TXT export feature and adjust Python version compatibility
1 parent 79833f0 commit 53598dc

File tree

2 files changed

+13
-20
lines changed

2 files changed

+13
-20
lines changed

.github/workflows/pylint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ jobs:
2222
- name: Analysing the code with pylint
2323
run: |
2424
pylint $(git ls-files '*.py') \
25-
--disable=missing-module-docstring,missing-function-docstring
25+
--disable=missing-module-docstring,missing-function-docstring,too-many-branches

README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
11
# EduPlannerBotAI
22

3-
**EduPlannerBotAI** is a Telegram bot built with `aiogram 3.x` and powered by OpenAI GPT. It generates personalized study plans, exports them to PDF, visualizes them as charts, and schedules reminders. All data is stored using TinyDB.
4-
5-
---
3+
**EduPlannerBotAI** is a Telegram bot built with `aiogram 3.x` and powered by OpenAI GPT. It generates personalized study plans, exports them to PDF/TXT, visualizes them as charts, and schedules reminders. All data is stored using TinyDB.
64

75
## 📌 Features
86

97
- 📚 Generate personalized study plans (LLM/OpenAI)
10-
- 📝 Export study plans to PDF
8+
- 📝 Export study plans to PDF/TXT
119
- 📊 Visualize plans with charts (matplotlib)
1210
- ⏰ Schedule reminders (async simulation)
1311
- 🗄️ Store data using TinyDB
1412

15-
---
16-
1713
## 🚀 Quick Start
1814

1915
### 1. Clone the project
@@ -41,8 +37,6 @@ OPENAI_API_KEY=your_openai_api_key
4137
python bot.py
4238
```
4339

44-
---
45-
4640
## ⚙️ Project Structure
4741
```
4842
EduPlannerBotAI/
@@ -51,10 +45,11 @@ EduPlannerBotAI/
5145
├── handlers/ # Command and message handlers
5246
│ ├── __init__.py
5347
│ ├── start.py # /start and greeting
54-
│ └── planner.py # Handle user requests
48+
│ └── planner.py # Study plan generation flow
5549
├── services/ # Core logic and helper functions
5650
│ ├── llm.py # OpenAI integration
5751
│ ├── pdf.py # PDF export
52+
│ ├── txt.py # TXT export
5853
│ ├── chart.py # Chart generation
5954
│ ├── reminders.py # Reminder simulation
6055
│ └── db.py # TinyDB database
@@ -63,39 +58,37 @@ EduPlannerBotAI/
6358
└── README.md # Project documentation
6459
```
6560

66-
---
67-
6861
## 🛠 Technologies Used
6962

7063
| Component | Purpose |
7164
|------------------|----------------------------------------|
72-
| Python 3.11+ | Programming language |
65+
| Python 3.8+ | Programming language |
7366
| aiogram 3.x | Telegram Bot Framework |
7467
| OpenAI API | LLM for text generation |
7568
| matplotlib | Chart rendering |
7669
| fpdf | PDF file generation |
7770
| TinyDB | Lightweight NoSQL database |
7871
| python-dotenv | Environment variable management |
7972

80-
---
73+
## 🔧 CI/CD
74+
75+
- GitHub Actions workflow for Pylint analysis
76+
- Python version compatibility: 3.8, 3.9, 3.10, 3.11, 3.12, 3.13
77+
- Custom `.pylintrc` configuration
8178

8279
## 🤝 Collaboration
8380

84-
We welcome contributions! If you'd like to improve this bot, fix bugs, or add features:
81+
We welcome contributions! If you'd like to improve this bot:
8582

8683
1. Fork the repository
8784
2. Create a feature branch (`git checkout -b feature-name`)
8885
3. Commit your changes
8986
4. Push to your fork
9087
5. Submit a pull request
9188

92-
---
93-
9489
## 📬 Contact
9590
Created with ❤️ for educational purposes. Feedback and collaboration:
9691
[@Aleksandr_Tk](https://t.me/Aleksandr_Tk)
9792

98-
---
99-
10093
## 📄 License
101-
MIT License
94+
MIT License

0 commit comments

Comments
 (0)