diff --git a/README.md b/README.md index 17869730..2e4420c4 100644 --- a/README.md +++ b/README.md @@ -38,25 +38,25 @@ ### Введение -Эта библиотека предоставляется Python интерфейс для никем незадокументированного и сделанного только для себя API Яндекс Музыки. +Эта библиотека предоставляет Python интерфейс для никем незадокументированного и сделанного только для себя API Яндекс Музыки. -Она совместима с версиями Python 3.7+ и поддерживает работу как с синхронном, так и асинхронным (asyncio) кодом. +Она совместима с версиями Python 3.7+ и поддерживает работу как с синхронным, так и с асинхронным (asyncio) кодом. -В дополнение к реализации чистого API данная библиотека имеет ряд классов-обёрток объектов высокого уровня дабы сделать разработку клиентов и скриптов простой и понятной. Вся документация была написана с нуля исходя из логического анализа в ходе обратной разработки(reverse engineering) API. +В дополнение к реализации чистого API данная библиотека имеет ряд классов-обёрток — объектов высокого уровня, дабы сделать разработку клиентов и скриптов простой и понятной. Вся документация была написана с нуля исходя из логического анализа в ходе обратной разработки (reverse engineering) API. #### Доступ к вашим данным Яндекс.Музыка -Начиная с версии [2.0.0](https://github.com/MarshalX/yandex-music-api/blob/a30082f4929e56381c870cb03103777ae29bcc6b/CHANGES.rst#%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F-200) библиотека больше не предоставляет интерфейсы для работы с OAuth Яндекс и Яндекс.Паспорт. Задача по получению токена для доступа к данным на плечах разработчиков использующих данную библиотеку. О том как получить токен читайте в документации. +Начиная с версии [2.0.0](https://github.com/MarshalX/yandex-music-api/blob/a30082f4929e56381c870cb03103777ae29bcc6b/CHANGES.rst#%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F-200) библиотека больше не предоставляет интерфейсы для работы с OAuth Яндекс и Яндекс.Паспорт. Задача по получению токена для доступа к данным лежит на плечах разработчиков, использующих данную библиотеку. О том как получить токен читайте в документации. ### Установка -Вы можете установить или обновить Yandex Music API при помощи: +Вы можете установить или обновить Yandex Music API с помощью команды: ``` shell pip install -U yandex-music ``` -Или Вы можете установить из исходного кода с помощью: +Или Вы можете установить из исходного кода с помощью команды: ``` shell git clone https://github.com/MarshalX/yandex-music-api @@ -66,7 +66,7 @@ python setup.py install ### Начало работы -Приступив к работе первым делом необходимо создать экземпляр клиента. +Приступив к работе, первым делом необходимо создать экземпляр клиента. Инициализация синхронного клиента: @@ -94,11 +94,11 @@ await client.init() client = await Client().init() ``` -Вызов `init()` необходим для получение информации для упрощения будущих запросов. +Вызов `init()` необходим для получения информации — упрощения будущих запросов. -Работа без авторизации ограничена. Так, например, для загрузки будут доступны только первые 30 секунд аудиофайла. Для понимания всех ограничений зайдите на сайт Яндекс.Музыка под инкогнито и воспользуйтесь сервисом. +Работа без авторизации ограничена. Так, например, для загрузки будут доступны только первые 30 секунд аудиофайла. Для понимания всех ограничений зайдите на сайт Яндекс.Музыка в режиме инкогнито и воспользуйтесь сервисом. -Для доступа к своим личным данным следует авторизоваться. Это осуществляется через токен аккаунта Яндекс.Музыка. +Для доступа к личным данным следует авторизоваться. Это осуществляется через токен аккаунта Яндекс.Музыка. Авторизация: @@ -110,7 +110,7 @@ client = Client('token').init() После успешного создания клиента Вы вольны в выборе необходимого метода из API. Все они доступны у объекта класса `Client`. Подробнее в методах клиента в [документации](https://yandex-music.readthedocs.io/en/latest/yandex_music.client.html). -Пример получения первого трека из плейлиста "Мне нравится" и его загрузка: +Пример получения первого трека из плейлиста "Мне нравится" и его загрузки: ``` python from yandex_music import Client @@ -119,7 +119,7 @@ client = Client('token').init() client.users_likes_tracks()[0].fetch_track().download('example.mp3') ``` -В примере выше клиент получает список треков которые были отмечены как понравившиеся. API возвращает объект [TracksList](https://yandex-music.readthedocs.io/en/latest/yandex_music.tracks_list.html) в котором содержится список с треками класса [TrackShort](https://yandex-music.readthedocs.io/en/latest/yandex_music.track_short.html). Данный класс содержит наиважнейшую информацию о треке и никаких подробностей, поэтому для получения полной версии трека со всей информацией необходимо обратиться к методу `fetch_track()`. Затем можно скачать трек методом `download()`. +В примере выше клиент получает список треков, которые были отмечены как понравившиеся. API возвращает объект [TracksList](https://yandex-music.readthedocs.io/en/latest/yandex_music.tracks_list.html), в котором содержится список с треками класса [TrackShort](https://yandex-music.readthedocs.io/en/latest/yandex_music.track_short.html). Данный класс содержит наиважнейшую информацию о треке и никаких подробностей, поэтому для получения полной версии трека со всей информацией необходимо обратиться к методу `fetch_track()`. Затем можно скачать трек методом `download()`. Пример получения треков по ID: @@ -142,7 +142,7 @@ request = Request(proxy_url='socks5://user:password@host:port') client = Client(request=request).init() ``` -Примеры proxy url: +Примеры Proxy URL: - socks5://user::port - - @@ -168,7 +168,7 @@ Socks прокси не поддерживаются в асинхронной Вот несколько примеров для обзора. Даже если это не Ваш подход к обучению, пожалуйста, возьмите и бегло просмотрите их. -Код примеров опубликован в открытом доступе, поэтому Вы можете взять его и начать писать вокруг своё. +Код примеров опубликован в открытом доступе, поэтому Вы можете взять его и начать писать вокруг него свой. Посетите [эту страницу](https://github.com/MarshalX/yandex-music-api/blob/main/examples/), чтобы изучить официальные примеры. @@ -198,7 +198,7 @@ await full_track.download() #### Логирование -Данная библиотека использует `logging` модуль. Чтобы настроить логирование на стандартный вывод, поместите +Данная библиотека использует модуль `logging`. Чтобы настроить логирование на стандартный вывод, поместите ``` python import logging @@ -253,7 +253,7 @@ logger.setLevel(logging.DEBUG) #### JavaScript -API wrapper на Node.JS. Не обновлялся больше двух лет: [itsmepetrov/yandex-music-api](https://github.com/itsmepetrov/yandex-music-api). Продолжение разработки заброшенной библиотеки: [kontsevoye/ym-api](https://github.com/kontsevoye/ym-api). +API wrapper на NodeJS. Не обновлялся больше двух лет: [itsmepetrov/yandex-music-api](https://github.com/itsmepetrov/yandex-music-api). Продолжение разработки заброшенной библиотеки: [kontsevoye/ym-api](https://github.com/kontsevoye/ym-api). ### Разработанные проекты diff --git a/docs/source/readme.content.md b/docs/source/readme.content.md index 07e29a4c..ae994704 100644 --- a/docs/source/readme.content.md +++ b/docs/source/readme.content.md @@ -1,24 +1,24 @@ # Введение -Эта библиотека предоставляется Python интерфейс для никем незадокументированного и сделанного только для себя API Яндекс Музыки. +Эта библиотека предоставляет Python интерфейс для никем незадокументированного и сделанного только для себя API Яндекс Музыки. -Она совместима с версиями Python 3.7+ и поддерживает работу как с синхронном, так и асинхронным (asyncio) кодом. +Она совместима с версиями Python 3.7+ и поддерживает работу как с синхронным, так и с асинхронным (asyncio) кодом. -В дополнение к реализации чистого API данная библиотека имеет ряд классов-обёрток объектов высокого уровня дабы сделать разработку клиентов и скриптов простой и понятной. Вся документация была написана с нуля исходя из логического анализа в ходе обратной разработки(reverse engineering) API. +В дополнение к реализации чистого API данная библиотека имеет ряд классов-обёрток — объектов высокого уровня, дабы сделать разработку клиентов и скриптов простой и понятной. Вся документация была написана с нуля исходя из логического анализа в ходе обратной разработки (reverse engineering) API. ## Доступ к вашим данным Яндекс.Музыка -Начиная с версии [2.0.0](https://github.com/MarshalX/yandex-music-api/blob/a30082f4929e56381c870cb03103777ae29bcc6b/CHANGES.rst#%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F-200) библиотека больше не предоставляет интерфейсы для работы с OAuth Яндекс и Яндекс.Паспорт. Задача по получению токена для доступа к данным на плечах разработчиков использующих данную библиотеку. О том как получить токен читайте в следующем разделе. +Начиная с версии [2.0.0](https://github.com/MarshalX/yandex-music-api/blob/a30082f4929e56381c870cb03103777ae29bcc6b/CHANGES.rst#%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F-200) библиотека больше не предоставляет интерфейсы для работы с OAuth Яндекс и Яндекс.Паспорт. Задача по получению токена для доступа к данным лежит на плечах разработчиков, использующих данную библиотеку. О том как получить токен читайте в документации. # Установка -Вы можете установить или обновить Yandex Music API при помощи: +Вы можете установить или обновить Yandex Music API с помощью команды: ``` shell pip install -U yandex-music ``` -Или Вы можете установить из исходного кода с помощью: +Или Вы можете установить из исходного кода с помощью команды: ``` shell git clone https://github.com/MarshalX/yandex-music-api @@ -28,7 +28,7 @@ python setup.py install # Начало работы -Приступив к работе первым делом необходимо создать экземпляр клиента. +Приступив к работе, первым делом необходимо создать экземпляр клиента. Инициализация синхронного клиента: @@ -56,11 +56,11 @@ await client.init() client = await Client().init() ``` -Вызов `init()` необходим для получение информации для упрощения будущих запросов. +Вызов `init()` необходим для получения информации — упрощения будущих запросов. -Работа без авторизации ограничена. Так, например, для загрузки будут доступны только первые 30 секунд аудиофайла. Для понимания всех ограничений зайдите на сайт Яндекс.Музыка под инкогнито и воспользуйтесь сервисом. +Работа без авторизации ограничена. Так, например, для загрузки будут доступны только первые 30 секунд аудиофайла. Для понимания всех ограничений зайдите на сайт Яндекс.Музыка в режиме инкогнито и воспользуйтесь сервисом. -Для доступа к своим личным данным следует авторизоваться. Это осуществляется через токен аккаунта Яндекс.Музыка. +Для доступа к личным данным следует авторизоваться. Это осуществляется через токен аккаунта Яндекс.Музыка. Авторизация: @@ -72,7 +72,7 @@ client = Client('token').init() После успешного создания клиента Вы вольны в выборе необходимого метода из API. Все они доступны у объекта класса `Client`. Подробнее в методах клиента в [документации](https://yandex-music.readthedocs.io/en/latest/yandex_music.client.html). -Пример получения первого трека из плейлиста "Мне нравится" и его загрузка: +Пример получения первого трека из плейлиста "Мне нравится" и его загрузки: ``` python from yandex_music import Client @@ -81,7 +81,7 @@ client = Client('token').init() client.users_likes_tracks()[0].fetch_track().download('example.mp3') ``` -В примере выше клиент получает список треков которые были отмечены как понравившиеся. API возвращает объект [TracksList](https://yandex-music.readthedocs.io/en/latest/yandex_music.tracks_list.html) в котором содержится список с треками класса [TrackShort](https://yandex-music.readthedocs.io/en/latest/yandex_music.track_short.html). Данный класс содержит наиважнейшую информацию о треке и никаких подробностей, поэтому для получения полной версии трека со всей информацией необходимо обратиться к методу `fetch_track()`. Затем можно скачать трек методом `download()`. +В примере выше клиент получает список треков, которые были отмечены как понравившиеся. API возвращает объект [TracksList](https://yandex-music.readthedocs.io/en/latest/yandex_music.tracks_list.html), в котором содержится список с треками класса [TrackShort](https://yandex-music.readthedocs.io/en/latest/yandex_music.track_short.html). Данный класс содержит наиважнейшую информацию о треке и никаких подробностей, поэтому для получения полной версии трека со всей информацией необходимо обратиться к методу `fetch_track()`. Затем можно скачать трек методом `download()`. Пример получения треков по ID: @@ -104,7 +104,7 @@ request = Request(proxy_url='socks5://user:password@host:port') client = Client(request=request).init() ``` -Примеры proxy url: +Примеры Proxy URL: - socks5://user::port - - @@ -130,7 +130,7 @@ Socks прокси не поддерживаются в асинхронной Вот несколько примеров для обзора. Даже если это не Ваш подход к обучению, пожалуйста, возьмите и бегло просмотрите их. -Код примеров опубликован в открытом доступе, поэтому Вы можете взять его и начать писать вокруг своё. +Код примеров опубликован в открытом доступе, поэтому Вы можете взять его и начать писать вокруг него свой. Посетите [эту страницу](https://github.com/MarshalX/yandex-music-api/blob/main/examples/), чтобы изучить официальные примеры. @@ -160,7 +160,7 @@ await full_track.download() ## Логирование -Данная библиотека использует `logging` модуль. Чтобы настроить логирование на стандартный вывод, поместите +Данная библиотека использует модуль `logging`. Чтобы настроить логирование на стандартный вывод, поместите ``` python import logging @@ -211,7 +211,7 @@ logger.setLevel(logging.DEBUG) ## JavaScript -API wrapper на Node.JS. Не обновлялся больше двух лет: [itsmepetrov/yandex-music-api](https://github.com/itsmepetrov/yandex-music-api). Продолжение разработки заброшенной библиотеки: [kontsevoye/ym-api](https://github.com/kontsevoye/ym-api). +API wrapper на NodeJS. Не обновлялся больше двух лет: [itsmepetrov/yandex-music-api](https://github.com/itsmepetrov/yandex-music-api). Продолжение разработки заброшенной библиотеки: [kontsevoye/ym-api](https://github.com/kontsevoye/ym-api). # Разработанные проекты