Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/issamansur/vkpymusic
The library allows developers to easily perform operations related to music and other functionalities available through the VK API.
https://github.com/issamansur/vkpymusic
api downloader github-pages hacktoberfest learn music playlist token vk
Last synced: about 1 month ago
JSON representation
The library allows developers to easily perform operations related to music and other functionalities available through the VK API.
- Host: GitHub
- URL: https://github.com/issamansur/vkpymusic
- Owner: issamansur
- License: mit
- Created: 2023-01-23T10:16:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T21:04:42.000Z (about 2 months ago)
- Last Synced: 2024-12-06T07:03:03.509Z (about 2 months ago)
- Topics: api, downloader, github-pages, hacktoberfest, learn, music, playlist, token, vk
- Language: Python
- Homepage: https://issamansur.github.io/vkpymusic/
- Size: 11.2 MB
- Stars: 24
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VKpyMusic
### is a Python library that provides a simple interface for interacting with the VKontakte (VK) music service API. The library allows developers to easily perform operations related to music and other functionalities available through the VK API.
### это библиотека Python, которая предоставляет простой интерфейс для взаимодействия с API музыкального сервиса ВКонтакте (VK). Библиотека позволяет разработчикам легко выполнять операции, связанные с музыкой и другими функциональными возможностями, доступными через VK API.
# Installation
### You can install VKpyMusic using the pip package manager. Open your command prompt or terminal and execute the following command:
### Вы можете установить VKpyMusic с помощью менеджера пакетов pip. Откройте командную строку или терминал и выполните следующую команду:
### Console:
```
pip install vkpymusic
```
# Usage
### To get started with VKpyMusic, you will need a valid VK access token and user agent, which provides access to the VK music service API. But if you don't have them, it's okay - we have our own class to get it.
### Чтобы начать работу с VKpyMusic, вам понадобится действительный токен доступа к VK и пользовательский агент, который предоставляет доступ к API музыкального сервиса VK. Но если у вас их нет, ничего страшного - у нас есть свой собственный класс, чтобы получить их.
## Example usage of VKpyMusic for receive token and user agent:
Пример использования VKpyMusic для получения токена и юзер-агента:
### Python:
```
from vkpymusic import TokenReceiver
login = input(" Enter login: ")
password = input("Enter password: ")
tokenReceiver = TokenReceiver(login, password)
if tokenReceiver.auth():
tokenReceiver.get_token()
tokenReceiver.save_to_config()
```
### Result:
```
Enter login: +...........
Enter password: .........
SMS with a confirmation code has been sent to your phone! The code is valid for a few minutes!
Code: 277765
Token was received!
Token was saved!
```
## Create an Service instance with your access token and user agent:
Создайте экземпляр Service с вашим токеном и юзер-агентом:
### Python:
```
from vkpymusic import Service
service = Service.parse_config()
```
## Or you can do like this:
Или Вы можете сделать так:
### Python:
```
service = Service("", "")
```
## Get information about the current user
Получить информацию о песнях текущего пользователя
### Python:
```
user_songs = service.get_songs_by_userid(5, 10)
```
## Search for tracks by query
Поиск треков по запросу
### Python:
```
songs = service.search_songs_by_text("Maroon V", 5)
```
## Full example
Полный пример
### Python:
```
from vkpymusic import Service, TokenReceiver
login = input(" Enter login: ")
password = input("Enter password: ")
tokenReceiver = TokenReceiver(login, password)
if tokenReceiver.auth():
tokenReceiver.get_token()
tokenReceiver.save_to_config()
service = Service.parse_config()
tracks = service.search_songs_by_text('idfc tiktok remix')
Service.save_music(tracks[0])
```
# Documentation
Документация
### Detailed documentation and usage examples for VKpyMusic can be found on the official project page on GitHub:
### Детальная документация и примеры использования для VKpyMusic находится на официальной странице на ГитХабе:
## https://github.com/issamansur/vkpymusic
## https://issamansur.github.io/vkpymusic/
# Contributions and Support
### Если у вас есть какие-либо предложения по улучшению VKpyMusic или вы обнаружите какие-либо проблемы, пожалуйста, создайте новую проблему на странице проекта GitHub. Мы приветствуем ваши запросы на исправления и готовы помочь вам с любыми проблемами, с которыми вы столкнетесь.
### If you have any suggestions for improving VKpyMusic or if you find any issues, please create a new issue on the GitHub project page. We welcome your pull requests and are here to assist you with any problems you encounter.
# License
### VKpyMusic is distributed under the MIT license. For detailed information about the license, see the LICENSE file.
# Authors
### VKpyMusic is developed by the @issamansur or/and 'EDEXADE, inc.' development team.