Skip to content

Версия 2.1.0: Документация, примеры и улучшенное сохранение

Choose a tag to compare

@Chu4hel Chu4hel released this 18 Oct 15:17
· 853 commits to main since this release

Этот релиз знаменует собой большой шаг в сторону дружелюбности к разработчикам и новым пользователям.
Основной упор был сделан на создание исчерпывающей документации, наглядных примеров и расширение функциональности для работы с конфигурационными файлами.

🚀 Новые возможности (Features)

  • Сайт документации: Настроен полноценный сайт документации с помощью MkDocs и Material for MkDocs. Теперь у проекта есть единый центр знаний.
  • Автоматическая генерация API: Справочник по API теперь генерируется автоматически из комментариев в коде, что гарантирует его актуальность.
  • Папка с примерами: Добавлена директория /examples с готовыми к запуску скриптами, демонстрирующими ключевые возможности библиотеки.
  • Запись в YAML: Функция save_config_value теперь поддерживает сохранение значений в .yml файлы (перезаписью, без сохранения комментариев).
  • Создание секций в INI: save_config_value теперь умеет не только обновлять, но и создавать новые секции в .ini файлах, если они не существуют.
  • Руководства для контрибьюторов: Добавлены файлы CONTRIBUTING.md и CODE_OF_CONDUCT.md для упрощения участия в разработке.

🛠 Улучшения и внутренние изменения (Improvements)

  • Стиль документации: Все комментарии в коде (docstrings) были переписаны в соответствии с единым Google-стилем для лучшей читаемости.
  • Обновление README: Главный README.md был полностью переработан для улучшения восприятия и добавления ссылок на новые разделы.
  • Тестовое покрытие: Расширены тесты для config.py, чтобы покрыть новую функциональность сохранения в YAML и создания секций в INI.
  • Уровни логирования: Скорректированы уровни некоторых сообщений в логах для уменьшения "шума" при стандартных настройках.

Full Changelog: v2.0.0...v2.1.0