From 36c76235eaced5a73ab63779d173a046eb5faf0a Mon Sep 17 00:00:00 2001 From: "Il'ya (Marshal)" Date: Wed, 16 Feb 2022 12:26:29 +0100 Subject: [PATCH] =?UTF-8?q?=D0=BE=D0=B1=D0=BD=D0=BE=D0=B2=D0=B8=D0=BB=20re?= =?UTF-8?q?adme,=20=D0=B3=D0=BE=D0=B4=20=D0=BA=D0=BE=D0=BF=D0=B8=D1=80?= =?UTF-8?q?=D0=B0=D0=B9=D1=82=D0=B0,=20manifest.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- MANIFEST.in | 2 +- README.rst | 32 +++++++++++++++++++++----------- docs/source/conf.py | 2 +- yandex_music/__init__.py | 2 +- 4 files changed, 24 insertions(+), 14 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index e904d6f..843b1e2 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1 @@ -include LICENSE Pipfile.lock CHANGES.rst \ No newline at end of file +include LICENSE CHANGES.rst \ No newline at end of file diff --git a/README.rst b/README.rst index f72ce7e..082183c 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ -API Yandex Music - неофициальная Python библиотека +API Yandex Music — неофициальная Python библиотека ================================================== -Делаю то, что по определённым причинам не сделала компания Yandex. + Делаю то, что по определённым причинам не сделала компания Yandex. Маленькое сообщество разработчиков общаются и помогают друг другу в `Telegram чатике `_, присоединяйтесь! @@ -22,8 +22,8 @@ API Yandex Music - неофициальная Python библиотека :target: https://www.codacy.com/manual/MarshalX/yandex-music-api :alt: Качество кода -.. image:: https://github.com/MarshalX/yandex-music-api/workflows/Full%20test/badge.svg - :target: https://github.com/MarshalX/yandex-music-api/actions?query=workflow%3A%22Full+test%22 +.. image:: https://github.com/MarshalX/yandex-music-api/actions/workflows/pytest_full.yml/badge.svg + :target: https://github.com/MarshalX/yandex-music-api/actions/workflows/pytest_full.yml :alt: Статус тестов .. image:: https://readthedocs.org/projects/yandex-music/badge/?version=latest @@ -59,6 +59,8 @@ API Yandex Music - неофициальная Python библиотека - `Получение помощи`_ +- `Список изменений`_ + - `Реализации на других языках`_ #. `C#`_ @@ -108,7 +110,7 @@ Microsoft Store. Так как API является закрытым и испо Установка ========= -Вы можете установить или обновить yandex-music-api при помощи: +Вы можете установить или обновить Yandex Music API при помощи: .. code:: shell @@ -118,7 +120,7 @@ Microsoft Store. Так как API является закрытым и испо .. code:: shell - $ git clone https://github.com/MarshalX/yandex-music-api --recursive + $ git clone https://github.com/MarshalX/yandex-music-api $ cd yandex-music-api $ python setup.py install @@ -158,7 +160,7 @@ Microsoft Store. Так как API является закрытым и испо client = Client.from_token('token') После успешного создания клиента Вы вольны в выборе необходимого метода -из API. Все они доступны у объекта класса Client. Подробнее в методах клиента +из API. Все они доступны у объекта класса ``Client``. Подробнее в методах клиента в `документации `_. Пример получения первого трека из плейлиста "Мне нравится" и его загрузка: @@ -177,7 +179,7 @@ Microsoft Store. Так как API является закрытым и испо `TrackShort `_. Данный класс содержит наиважнейшую информацию о треке и никаких подробностей, поэтому для получения полной версии трека со всей информацией необходимо -обратиться к методу fetch_track(). Затем можно скачать трек методом download(). +обратиться к методу ``fetch_track()``. Затем можно скачать трек методом ``download()``. Пример получения треков по ID: @@ -277,7 +279,7 @@ music.yandex.ru/album/**1193829**/track/**10994777** logger = logging.getLogger() logger.setLevel(logging.INFO) -Если Вы хотите DEBUG логирование: +Если Вы хотите ``DEBUG`` логирование: .. code:: python @@ -301,9 +303,17 @@ music.yandex.ru/album/**1193829**/track/**10994777** Получить помощь можно несколькими путями: - Задать вопрос в `Telegram чатике `_, где мы помогаем друг другу, присоединяйтесь! -- Сообщить о баге, предложить новую фичу или задать вопрос можно `создав issue `_. +- Сообщить о баге можно `создав Bug Report `_. +- Предложить новую фичу или задать вопрос можно `создав discussion `_. - Найти ответ на вопрос в `документации библиотеки `_. +================ +Список изменений +================ + +Весь список изменений ведётся в файле `CHANGES.rst `_. + + =========================== Реализации на других языках =========================== @@ -363,7 +373,7 @@ Telegram бот-клиент Сайт проекта: `music-yandex-bot.ru `_. Бот в Telegram: `@music_yandex_bot `_. -Автор: `@MarshalX `_. +Автор: `@MarshalX `_. Статья на habr.com с описанием реализации: `Под капотом бота-клиента Яндекс.Музыки `_. diff --git a/docs/source/conf.py b/docs/source/conf.py index 5b085cf..e39f1b5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -20,7 +20,7 @@ master_doc = 'index' # -- Project information ----------------------------------------------------- project = 'Yandex Music API' -copyright = '2019-2021 Il`ya (Marshal) ' +copyright = '2019-2022 Il`ya (Marshal) ' author = 'Il`ya Semyonov' language = 'ru' diff --git a/yandex_music/__init__.py b/yandex_music/__init__.py index fc5ba8e..f6d478f 100644 --- a/yandex_music/__init__.py +++ b/yandex_music/__init__.py @@ -1,6 +1,6 @@ __version__ = '1.0.0' __license__ = 'GNU Lesser General Public License v3 (LGPLv3)' -__copyright__ = 'Copyright (C) 2019-2021 Il`ya (Marshal) ' +__copyright__ = 'Copyright (C) 2019-2022 Il`ya (Marshal) ' from .base import YandexMusicObject