yandex-music 2.0.1

Yandex 音乐 API

Делаю то, что по определённым причинам не сделала компания Yandex。

⚠️ Это неофициальная библиотека。

Сообщество разработчиков общаются и помогают друг другу в Telegram чате , присоединяйтесь！

Содержание

• Введение

  1. Доступ к вашим данным Яндекс.Музыка

• Установка

• Начало работы

  1. Изучение по примерам

  2. Особенности использования асинхронного клиента

  3. Логирование

  4. Документация

• Получение помощи

• Список изменений

• Реализации на других языках

  1. C＃

  2. PHP

  3. JavaScript

• Разработанные проекты

  1. Плагин для Kodi

  2. 电报бот-клиент

• Благодарность

• Внесение своего вклада в проект

• Лицензия

Введение

Эта библиотека предоставляется Python интерфейс для никем незадокументированного и сделанного только для себя API Яндекс Музыки。

Она совместима с версиями Python 3.7+ 和 поддерживает работу как с синхронном, так и асинхронным (asyncio) кодом。

В дополнение к реализации чистого API данная библиотека имеет ряд классов-обёрток объектов высокого уровня дабы сделать разработку клиентов и скриптов простой и понятной. Вся документация была написана с нуля исходя из логического анализа в ходе обратной разработки（逆向工程）API。

Установка

Выможете установить или обновить Yandex Music API при помощи：

pip install yandex-music --upgrade

Или Вы можете установить из исходного кода с помощью:

git clone https://github.com/MarshalX/yandex-music-api
cd yandex-music-api
python setup.py install

Начало работы

Приступив к работе первым делом необходимо создать экземпляр клиента。

Инициализация синхронного клиента:

from yandex_music import Client

client = Client()
client.init()

# или

client = Client().init()

Инициализация асинхронного клиента:

from yandex_music import ClientAsync

client = ClientAsync()
await client.init()

# или

client = await Client().init()

Вызов init() необходим для получение информации для упрощения будущих запросов。

Работа без авторизации ограничена。Так, например, для загрузки будут доступны только первые 30 секунд аудиофайла。Для понимания всех ограничений зайдите на сайт Яндекс.Музыка под инкогнито и воспользуйтесь сервисом。

Для доступа к своим личным данным следует авторизоваться。Это осуществляется через токен аккаунта Яндекс.Музыка。

Авторизация:

from yandex_music import Client

client = Client('token').init()

После успешного создания клиента Вы вольны в выборе необходимого метода из API。Все они доступны у объекта класса客户。Подробнее в методах клиента в документации。

Пример получения первого трека из плейлиста “Мне нравится” и его загрузка:

from yandex_music import Client

client = Client('token').init()
client.users_likes_tracks()[0].fetch_track().download('example.mp3')

В примере выше клиент получает список треков которые были отмечены как понравившиеся。API возвращает объект TracksList в котором содержится список с треками класса TrackShort。Данный класс содержит наиважнейшую информацию о треке и никаких подробностей, поэтому для получения полной версии трека со всей информацией необходимо обратиться к методу fetch_track() . Затем можно скачать трек методом下载（）。

Пример получения треков по ID:

from yandex_music import Client

client = Client().init()
client.tracks(['10994777:1193829', '40133452:5206873', '48966383:6693286', '51385674:7163467'])

В качестве ID трека выступает его уникальный номер и номер альбома。Первым треком из примера является следующий трек: music.yandex.ru/album/ 1193829 /track/ 10994777

Выполнение запросов с использование прокси в синхронной версии:

from yandex_music.utils.request import Request
from yandex_music import Client

request = Request(proxy_url='socks5://user:password@host:port')
client = Client(request=request).init()

Примеры 代理网址：

• socks5://user:password@host:port

• http://主机：端口

• https://主机：端口

• http://user:password@host

Больше примеров тут:代理 - 高级用法 - 请求

Выполнение запросов с использование прокси в асинхронной версии:

from yandex_music.utils.request_async import Request
from yandex_music import ClientAsync

request = Request(proxy_url='http://user:pass@some.proxy.com')
client = await ClientAsync(request=request).init()

袜子 прокси не поддерживаются в асинхронной версии。

Про поддерживаемые прокси тут:代理支持 - 高级用法 - aiohttp

from yandex_music import ClientAsync

client = await ClientAsync('token').init()
liked_short_track = (await client.users_likes_tracks())[0]

# правильно
full_track = await liked_short_track.fetch_track_async()
await full_track.download_async()

# НЕПРАВИЛЬНО
full_track = await liked_short_track.fetch_track()
await full_track.download()

import logging
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

logger = logging.getLogger()
logger.setLevel(logging.INFO)

logger.setLevel(logging.DEBUG)

Документация

Документация yandex-music-api расположена на readthedocs.io。Вашей отправной точкой должен быть класс Client , а точнее его методы。Именно они выполняют все запросы на API и возвращают Вам готовые объекты。 Класс Client 上 readthedocs.io。

Получение помощи

Получить помощь можно несколькими путями:

• Задать вопрос в Telegram чате , где мы помогаем друг другу, присоединяйтесь！

• Сообщить о баге можно создав 错误报告。

• Предложить новую фичу или задать вопрос можно создав 讨论。

• Найти ответ на вопрос в документации библиотеки。

Список изменений

Весь список изменений ведётся в файле CHANGES.rst。

Реализации на других языках

Разработанные проекты

Плагин для Kodi

Плагин может проигрывать пользовательские плейлисты и плейлисты Яндекса, поиск по Яндекс Музыке, радио。

Сайт проекта: ymkodi.ru。Исходный код: kodi.plugin.yandex-music。Автор: @Angel777d。

电报бот-клиент

Неофициальный бот。Умные и ваши плейлисты, понравившиеся треки。Лайки, дизлайки, текста песен, поиск, распознавание песен, похожие треки！Полноценный клиент на базе мессенджера。

Сайт проекта: music-yandex-bot.ru。Бот в 电报：@music_yandex_bot。Автор：@MarshalX。

Статья на habr.com с описанием реализации: Под капотом бота-клиента Яндекс.Музыки。

Благодарность

Спасибо разработчикам python-telegram-bot。Выбрал Вас в качестве примера。

Внесение своего вклада в проект

Внесение своего вклада максимально приветствуется！Есть перечень пунктов, который стоит соблюдать。Каждый пункт перечня расписан в CONTRIBUTING.md。

Вы можете помочь и сообщив о баге или о новом поле пришедшем от API。

Лицензия

Вы можете копировать, распространять и модифициров​​ать программное обеспечение при условии, что модификации описаны и лицензированы бесплатно в соответствии с LGPL-3 . Произведения производных (включая модификации или что-либо статически связанное с библиотекой) могут распространяться только в соответствии с LGPL-3, но приложения, которые используют библиотеку, необязательно.