diff --git a/CHANGES.rst b/CHANGES.rst index 79ef48fb..9b6c722a 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -2,6 +2,85 @@ Список изменений ================ +Версия 0.1.1 +============ + +**25.03.2020** + +**Закончено документирование всех классов и основных методов!** + +**Переломные изменения** + +- Классы отметок "мне нравится" для альбомов, плейлистов и исполнителей обобщены. Теперь представлены одним классом. + - Удаленные классы: + - ``ArtistsLikes``. + - ``AlbumsLikes``. + - ``PlaylistsLikes``. + - Новый класс: ``Like`` (поле ``type`` для определения содержимого). +- Изменено название пакета с ``status`` на ``account`` (`#195`_). +- Исправлено выбрасываемое исключение при таймауте: + - Прошлое исключение: ``TimeoutError`` (built-in). + - Новое исключение: ``TimedOut`` (``yandex_music.exceptions``). +- Удалены следующие файлы: ``requirements.txt``, ``requirements-dev.txt``, ``requirements-docs.txt``. + +**Крупные изменения** + +- Добавлено обнаружение новых полей с просьбой сообщить о них (`#216`_). + - Добавлена проверка на неизвестные поля. + - Добавлен вывод отладочной информации в виде warning'a. + - Добавлен шаблон issue для отправки логов. +- Добавлено поле ``type`` для класса ``SearchResult`` для определения типа результата поиска по объекту. +- Добавлены настройки пользователя (`#195`_): + - Добавлен класс ``UserSettings``. + - Добавлен метод для получения своих настроек (``account_settings``). + - Добавлен метод для получения настроек другого пользователя (``users_settings``). + - Добавлен метод для изменения настроек (``account_settings_set``). +- Добавлен возможность получить похожие треки (`#197`_): + - Добавлен класс ``TracksSimilar`` с полями трека и списка похожих треков. + - Добавлен метод для получения похожих треков (``tracks_similar``). +- Добавлены шоты от Алисы (`#185`_): + - Добавлен метод ``after_track`` в класс ``Client`` для получения контента для воспоризведения после трека (реклама, шот). + - Добавлены методы для загрузки обложки и аудиоверсии шота. + - Добавлены новые классы: + - ``Shot`` + - ``ShotData`` + - ``ShotEvent`` + - ``ShotType`` +- Добавлен метод для изменения видимости плейлиста (`#179`_). +- Добавлена поддержка Яндекс.Радио (`#20`_): + - Исправлена отправка фидбека. + - Написана инструкция по использованию (в доке к методу). + - Добавлен аругмент для перехода по цепочке треков. + - Добавлен метод для изменения настроек станции. + +**Незначительные изменения и/или исправления** + +- Убрано дублирование информации в документации (`#247`_). +- Добавленые новые поля в класс ``Track``: ``version``, ``remember_position`` (`#238`_). +- Добавлено исключение ``InvalidBitrate`` при попытке загрузить недопустимый трек по критериям (кодек, битрейт). +- Исправлено получение прямой ссылки на файл с кодеком AAC (`#237`_, `#25`_). +- Исправлено получение плейлиста с Алисой в лендинге (`#185`_). +- Исправлено название поля с ссылкой на источник в классе ``Description`` (с ``url`` на ``uri``). +- Исправлена десериализация несуществующего исполнителя. +- Добавлено поле ``version`` в класс ``Album`` (`#178`_). +- Поле ``picture`` класса ``Vinyl`` теперь опциональное. +- Поле ``week`` класса ``Ratings`` теперь опциональное. +- Поле ``product_id`` класса ``AutoRenewable`` теперь опциональное (`#182`_). +- Правки замечаний по codacy. + +.. _`#216`: https://github.com/MarshalX/yandex-music-api/issues/216 +.. _`#247`: https://github.com/MarshalX/yandex-music-api/issues/247 +.. _`#237`: https://github.com/MarshalX/yandex-music-api/issues/237 +.. _`#25`: https://github.com/MarshalX/yandex-music-api/issues/25 +.. _`#238`: https://github.com/MarshalX/yandex-music-api/issues/238 +.. _`#182`: https://github.com/MarshalX/yandex-music-api/issues/182 +.. _`#195`: https://github.com/MarshalX/yandex-music-api/issues/195 +.. _`#197`: https://github.com/MarshalX/yandex-music-api/issues/197 +.. _`#20`: https://github.com/MarshalX/yandex-music-api/issues/20 +.. _`#185`: https://github.com/MarshalX/yandex-music-api/issues/185 +.. _`#179`: https://github.com/MarshalX/yandex-music-api/issues/179 +.. _`#178`: https://github.com/MarshalX/yandex-music-api/issues/178 + Версия 0.0.16 ============= diff --git a/README.rst b/README.rst index b2dc9063..6003ee7d 100644 --- a/README.rst +++ b/README.rst @@ -280,12 +280,15 @@ music.yandex.ru/album/**1193829**/track/**10994777** logger.setLevel(logging.DEBUG) -============= +============ Документация -============= +============ Документация ``yandex-music-api`` расположена на `readthedocs.io `_. +Вашей отправной точкой должен быть класс ``Client``, а точнее его методы. Именно они выполняют все +запросы на API и возвращают Вам готовые объекты. +`Класс Client на readthedocs.io `_. ================ Получение помощи @@ -338,14 +341,14 @@ API wrapper на Node.JS. Не обновлялся больше двух лет Плагин может проигрывать пользовательские плейлисты и плейлисты Яндекса, поиск по Яндекс Музыке, радио. -Сайт проекта: `Kodi Yandex Music `_. +Сайт проекта: `ymkodi.ml `_. Исходный код: `kodi.plugin.yandex-music `_ Автор: `@Angel777d `_ .. image:: https://raw.githubusercontent.com/Angel777d/kodi.plugin.yandex-music/master/assets/img/kody_yandex_music_plugin.png - :target: https://angel777d.github.io/kodi.plugin.yandex-music/ + :target: https://ymkodi.ml/ :alt: Плагин для Kodi ------------------- diff --git a/setup.py b/setup.py index 9cb9ada8..18cafc25 100644 --- a/setup.py +++ b/setup.py @@ -30,12 +30,12 @@ def requirements(section): setup(name='yandex-music', - version='0.0.16', + version='0.1.1', author='Il`ya Semyonov', author_email='Ilya@marshal.by', license='LGPLv3', url='https://github.com/MarshalX/yandex-music-api/', - keywords='python yandex music api wrapper library питон яндекс музыка апи обёртка библиотека', + keywords='python yandex music api wrapper library питон пайтон яндекс музыка апи обёртка библиотека', description='Делаю то, что по определённым причинам не сделала компания Yandex.', long_description=f'{readme}\n{changes}', packages=packages,