2019-07-09 14:54:25 +09:00
|
|
|
|
[Pre-Alpha] Неофициальная Python библиотека для API Yandex Music
|
|
|
|
|
================================================================
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
2019-11-10 09:22:32 +09:00
|
|
|
|
Делаю то, что по определённым причинам не сделала компания Yandex.
|
|
|
|
|
|
|
|
|
|
Маленькое сообщество разработчиков общаются и помогают друг другу в `Telegram чатике <https://t.me/yandex_music_api>`_, присоединяйтесь!
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
|
|
|
|
.. image:: https://img.shields.io/pypi/v/yandex-music.svg
|
|
|
|
|
:target: https://pypi.org/project/yandex-music/
|
|
|
|
|
:alt: Версия пакета PyPi
|
|
|
|
|
|
2019-11-10 09:22:32 +09:00
|
|
|
|
.. image:: https://img.shields.io/badge/python-3.6%20|%203.7%20|%203.8-blue.svg
|
2019-07-06 18:44:18 +09:00
|
|
|
|
:target: https://pypi.org/project/yandex-music/
|
|
|
|
|
:alt: Поддерживаемые Python версии
|
|
|
|
|
|
2019-11-10 06:49:28 +09:00
|
|
|
|
.. image:: https://codecov.io/gh/MarshalX/yandex-music-api/branch/development/graph/badge.svg
|
|
|
|
|
:target: https://codecov.io/gh/MarshalX/yandex-music-api
|
|
|
|
|
:alt: Покрытие кода тестами
|
|
|
|
|
|
2019-11-10 09:22:32 +09:00
|
|
|
|
.. image:: https://api.codacy.com/project/badge/Grade/27011a5a8d9f4b278d1bfe2fe8725fed
|
|
|
|
|
: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
|
|
|
|
|
:alt: Статус тестов
|
|
|
|
|
|
2019-07-06 20:15:03 +09:00
|
|
|
|
.. image:: https://readthedocs.org/projects/yandex-music/badge/?version=latest
|
2019-11-10 06:49:28 +09:00
|
|
|
|
:target: https://yandex-music.readthedocs.io/ru/latest/?badge=latest
|
|
|
|
|
:alt: Статус документации
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
|
|
|
|
.. image:: https://img.shields.io/badge/license-LGPLv3-lightgrey.svg
|
|
|
|
|
:target: https://www.gnu.org/licenses/lgpl-3.0.html
|
|
|
|
|
:alt: Лицензия LGPLv3
|
|
|
|
|
|
2019-11-10 09:22:32 +09:00
|
|
|
|
.. image:: https://img.shields.io/badge/telegram-чат-blue.svg
|
|
|
|
|
:target: https://t.me/yandex_music_api
|
|
|
|
|
:alt: Telegram чат
|
|
|
|
|
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
|
|
|
|
==========
|
|
|
|
|
Содержание
|
|
|
|
|
==========
|
|
|
|
|
|
|
|
|
|
- `Введение`_
|
|
|
|
|
|
2019-08-12 05:47:02 +09:00
|
|
|
|
#. `Доступ к вашим данным на Яндексе`_
|
|
|
|
|
|
2019-07-06 18:44:18 +09:00
|
|
|
|
- `Установка`_
|
|
|
|
|
|
|
|
|
|
- `Начало работы`_
|
|
|
|
|
|
|
|
|
|
#. `Изучение по примерам`_
|
|
|
|
|
|
|
|
|
|
#. `Логирование`_
|
|
|
|
|
|
|
|
|
|
#. `Документация`_
|
|
|
|
|
|
2019-11-10 09:22:32 +09:00
|
|
|
|
- `Получение помощи`_
|
|
|
|
|
|
2019-07-06 18:49:01 +09:00
|
|
|
|
- `Благодарность`_
|
|
|
|
|
|
2019-07-06 18:44:18 +09:00
|
|
|
|
- `Лицензия`_
|
|
|
|
|
|
|
|
|
|
========
|
|
|
|
|
Введение
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
Эта библиотека предоставляется Python интерфейс для никем
|
|
|
|
|
незадокументированного и сделанного только для себя API Яндекс Музыки.
|
|
|
|
|
|
2019-11-08 04:52:26 +09:00
|
|
|
|
Она совместима с версиями Python 3.6+.
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
|
|
|
|
В дополнение к реализации чистого API данная библиотека имеет ряд
|
|
|
|
|
классов-обёрток объектов высокого уровня дабы сделать разработку клиентов
|
|
|
|
|
и скриптов простой и понятной.
|
|
|
|
|
|
2019-08-12 05:47:02 +09:00
|
|
|
|
--------------------------------
|
|
|
|
|
Доступ к вашим данным на Яндексе
|
|
|
|
|
--------------------------------
|
|
|
|
|
|
|
|
|
|
Значения констант `CLIENT_ID и CLIENT_SECRET <https://github.com/MarshalX/yandex-music-api/blob/master/yandex_music/client.py#L11>`_
|
2019-08-24 19:53:04 +09:00
|
|
|
|
позаимствовано у официального приложения-клиента сервиса Яндекс.Музыка из магазина
|
|
|
|
|
Microsoft Store. Так как API является закрытым и используется только внутри
|
|
|
|
|
компании Яндекс сейчас невозможно зарегистрировать своё собственное приложение на
|
|
|
|
|
`oauth.yandex.ru <https://oauth.yandex.ru/>`_, а следовательно, использовать свои
|
|
|
|
|
значения констант.
|
2019-08-12 05:47:02 +09:00
|
|
|
|
|
2019-07-06 18:44:18 +09:00
|
|
|
|
=========
|
|
|
|
|
Установка
|
|
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
**Библиотека находится в стадии разработки**
|
|
|
|
|
|
|
|
|
|
Вы можете установить или обновить yandex-music-api при помощи:
|
|
|
|
|
|
|
|
|
|
.. code:: shell
|
|
|
|
|
|
2019-07-06 19:34:14 +09:00
|
|
|
|
$ pip install yandex-music --upgrade
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
|
|
|
|
Или Вы можете установить из исходного кода с помощью:
|
|
|
|
|
|
|
|
|
|
.. code:: shell
|
|
|
|
|
|
2019-07-06 18:49:01 +09:00
|
|
|
|
$ git clone https://github.com/MarshalX/yandex-music-api --recursive
|
|
|
|
|
$ cd yandex-music-api
|
2019-07-06 18:44:18 +09:00
|
|
|
|
$ python setup.py install
|
|
|
|
|
|
|
|
|
|
=============
|
|
|
|
|
Начало работы
|
|
|
|
|
=============
|
|
|
|
|
|
2019-08-24 19:53:04 +09:00
|
|
|
|
Приступив к работе первым делом необходимо создать экземпляр клиента.
|
|
|
|
|
|
|
|
|
|
Инициализация клиента:
|
|
|
|
|
|
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
from yandex_music.client import Client
|
|
|
|
|
|
|
|
|
|
client = Client()
|
|
|
|
|
|
|
|
|
|
Для доступа к своим личным данным следует авторизоваться.
|
|
|
|
|
Это можно осуществить через OAuth токен или логин с паролем.
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
2019-07-09 14:54:25 +09:00
|
|
|
|
Авторизация по логину и паролю:
|
2019-07-09 14:58:17 +09:00
|
|
|
|
|
2019-07-09 14:54:25 +09:00
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
from yandex_music.client import Client
|
|
|
|
|
|
2019-08-24 19:53:04 +09:00
|
|
|
|
client = Client.from_credentials('example@yandex.com', 'password')
|
2019-07-09 14:54:25 +09:00
|
|
|
|
|
|
|
|
|
Авторизация по токену:
|
2019-07-09 14:58:17 +09:00
|
|
|
|
|
2019-07-09 14:54:25 +09:00
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
from yandex_music.client import Client
|
|
|
|
|
|
|
|
|
|
client = Client.from_token('token')
|
2019-08-24 19:53:04 +09:00
|
|
|
|
# или
|
|
|
|
|
client = Client('token')
|
2019-07-09 14:54:25 +09:00
|
|
|
|
|
|
|
|
|
После успешного создания клиента Вы вольны в выборе необходимого метода
|
|
|
|
|
из API. Все они доступны у объекта класса Client. Подробнее в методах клиента
|
|
|
|
|
в `документации <https://yandex-music.readthedocs.io/ru/latest/yandex_music.client.html>`_.
|
|
|
|
|
|
|
|
|
|
Пример получения первого трека из плейлиста "Мне нравится" и его загрузка:
|
2019-07-09 14:58:17 +09:00
|
|
|
|
|
2019-07-09 14:54:25 +09:00
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
from yandex_music.client import Client
|
|
|
|
|
|
2019-08-24 19:53:04 +09:00
|
|
|
|
client = Client.from_credentials('example@yandex.com', 'password')
|
2019-07-09 14:54:25 +09:00
|
|
|
|
client.users_likes_tracks()[0].track.download('example.mp3')
|
|
|
|
|
|
|
|
|
|
В примере выше клиент получает список треков которые были отмечены как
|
|
|
|
|
понравившиеся. API возвращает объект
|
|
|
|
|
`TracksList <https://yandex-music.readthedocs.io/ru/latest/yandex_music.tracks_list.html>`_
|
|
|
|
|
в котором содержится список с треками класса
|
|
|
|
|
`TrackShort <https://yandex-music.readthedocs.io/ru/latest/yandex_music.track_short.html>`_.
|
|
|
|
|
Данные класс содержит наиважнейшую информацию о треке и никаких подробностей,
|
|
|
|
|
поэтому для получения полной версии трека со всей информацией необходимо
|
|
|
|
|
обратиться к свойству track. Затем можно скачать трек методом download().
|
|
|
|
|
|
|
|
|
|
Пример получения треков по ID:
|
2019-07-09 14:58:17 +09:00
|
|
|
|
|
2019-07-09 14:54:25 +09:00
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
from yandex_music.client import Client
|
|
|
|
|
|
2019-08-24 19:53:04 +09:00
|
|
|
|
client = Client()
|
2019-07-09 14:54:25 +09:00
|
|
|
|
client.tracks(['10994777:1193829', '40133452:5206873', '48966383:6693286', '51385674:7163467'])
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
2019-08-24 19:53:04 +09:00
|
|
|
|
В качестве ID трека выступает его уникальный номер и номер альбома.
|
|
|
|
|
Первым треком из примера является следующий трек:
|
|
|
|
|
music.yandex.ru/album/**1193829**/track/**10994777**
|
|
|
|
|
|
2019-07-06 18:44:18 +09:00
|
|
|
|
--------------------
|
|
|
|
|
Изучение по примерам
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
Вот несколько примеров для обзора. Даже если это не Ваш подход к
|
|
|
|
|
обучению, пожалуйста, возьмите и бегло просмотрите их.
|
|
|
|
|
|
|
|
|
|
Код примеров опубликован в открытом доступе, поэтому
|
|
|
|
|
Вы можете взять его и начать писать вокруг своё.
|
|
|
|
|
|
2019-07-13 08:39:17 +09:00
|
|
|
|
Посетите `эту страницу <https://github.com/MarshalX/yandex-music-api/blob/master/examples/>`_
|
2019-07-06 18:44:18 +09:00
|
|
|
|
чтобы изучить официальные примеры.
|
|
|
|
|
|
|
|
|
|
-----------
|
|
|
|
|
Логирование
|
|
|
|
|
-----------
|
|
|
|
|
|
2019-08-24 19:53:04 +09:00
|
|
|
|
Данная библиотека использует ``logging`` модуль. Чтобы настроить логирование на
|
|
|
|
|
стандартный вывод, поместите
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
import logging
|
|
|
|
|
logging.basicConfig(level=logging.DEBUG,
|
|
|
|
|
format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
|
|
|
|
|
|
|
|
|
|
в начало вашего скрипта.
|
|
|
|
|
|
2019-08-24 19:53:04 +09:00
|
|
|
|
Вы также можете использовать логирование в вашем приложении, вызвав
|
|
|
|
|
``logging.getLogger()`` и установить уровень какой Вы хотите:
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
logger = logging.getLogger()
|
|
|
|
|
logger.setLevel(logging.INFO)
|
|
|
|
|
|
|
|
|
|
Если Вы хотите DEBUG логирование:
|
|
|
|
|
|
|
|
|
|
.. code:: python
|
|
|
|
|
|
|
|
|
|
logger.setLevel(logging.DEBUG)
|
|
|
|
|
|
|
|
|
|
=============
|
|
|
|
|
Документация
|
|
|
|
|
=============
|
|
|
|
|
|
2019-08-24 19:53:04 +09:00
|
|
|
|
Документация ``yandex-music-api`` находится в стадии написания и расположена на
|
|
|
|
|
`readthedocs.io <https://yandex-music.readthedocs.io/>`_.
|
2019-07-06 18:44:18 +09:00
|
|
|
|
|
2019-11-10 09:22:32 +09:00
|
|
|
|
================
|
|
|
|
|
Получение помощи
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
Получить помощь можно несколькими путями:
|
|
|
|
|
|
|
|
|
|
- Задать вопрос в `Telegram чатике <https://t.me/yandex_music_api>`_, где мы помогаем друг другу, присоединяйтесь!
|
|
|
|
|
- Сообщить о баге, предложить новую фичу или задать вопрос можно `создав issue <https://github.com/MarshalX/yandex-music-api/issues/new/choose>`_.
|
|
|
|
|
- Найти ответ на вопрос в `документации библиотеки <https://yandex-music.readthedocs.io/ru/latest/>`_.
|
|
|
|
|
|
2019-07-06 18:49:01 +09:00
|
|
|
|
=============
|
|
|
|
|
Благодарность
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
Спасибо разработчикам ``python-telegram-bot``. Выбрал Вас в качестве примера.
|
|
|
|
|
|
2019-07-06 18:44:18 +09:00
|
|
|
|
========
|
|
|
|
|
Лицензия
|
|
|
|
|
========
|
|
|
|
|
|
2019-08-24 19:53:04 +09:00
|
|
|
|
Вы можете копировать, распространять и модифицировать программное обеспечение
|
|
|
|
|
при условии, что модификации описаны и лицензированы бесплатно в соответствии
|
|
|
|
|
с `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_. Произведения
|
|
|
|
|
производных (включая модификации или что-либо статически связанное с библиотекой)
|
|
|
|
|
могут распространяться только в соответствии с LGPL-3, но приложения, которые
|
|
|
|
|
используют библиотеку, необязательно.
|