Skip to content

🎉 EduPlannerBotAI 2.0.0 — Major Release

Choose a tag to compare

View all tags
@AlexTkDev AlexTkDev released this 27 Jun 19:32
· 59 commits to main since this release
2.0.0
6bdfd47

🚀 Highlights

  • Full English Codebase
    All comments, docstrings, messages, and code structure are now in English for international collaboration and open source contribution.

  • PEP8 & pylint 10/10
    The project fully complies with PEP8 and strict pylint settings (max-line-length=100, import order, final newlines, etc.).
    The .pylintrc includes exceptions for test files to avoid unnecessary warnings for test dummies.

  • Comprehensive Test Coverage
    Tests included for:

    • Study plan generation (local and OpenAI)
    • PDF and TXT export
    • TinyDB database operations
    • Reminder scheduler
    • Bot commands (including /start)
    • All tests pass (pytest green)

  • Docker & CI/CD Ready

    • Optimized Dockerfile and docker-compose.yml for fast deployment.
    • GitHub Actions for automatic code quality checks (pylint) and tests.
    • .gitignore excludes all temp/cache/sensitive files.

  • Architecture Improvements

    • Asynchronous file operations (aiofiles).
    • Safe error handling and fallback to local generator if OpenAI fails.
    • Token and environment variable checks at startup.

🛠 How to Upgrade

  1. Update your repository: 
    git fetch --tags
git checkout 2.0.0
  2. Check your .env for required variables (BOT_TOKEN, OPENAI_API_KEY).
  3. Build and run the container: 
    docker-compose up --build
  4. Run tests: 
    pytest

📝 Compatibility

  • Python 3.10+
  • Compatible with aiogram 3.x, OpenAI API, TinyDB, fpdf, aiofiles

🧑‍💻 For Developers

  • All tests are in the tests/ folder.
  • For local development, use a virtual environment (.venv), which is git-ignored.
  • For CI/CD, use GitHub Actions (.github/workflows/pylint.yml).

📦 What’s Next?

  • Easily extendable: add new commands, integrate other LLMs, support more export formats.
  • Ready for open source contributions and team development.

Thank you for using EduPlannerBotAI!
If you find a bug or want to suggest an improvement, please open an issue or pull request on GitHub.

Let me know if you want a "Changelog" section or a GitHub Releases–style summary!

Assets 2
Loading