# 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:<br>Пример использования 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:<br>Создайте экземпляр Service с вашим токеном и юзер-агентом:
### Python:
```
from vkpymusic import Service
service = Service.parse_config()
```
## Or you can do like this:<br>Или Вы можете сделать так:
### Python:
```
service = Service("<your_token>", "<your_client>")
```
## Get information about the current user<br>Получить информацию о песнях текущего пользователя
### Python:
```
user_songs = service.get_songs_by_userid(5, 10)
```
## Search for tracks by query<br>Поиск треков по запросу
### Python:
```
songs = service.search_songs_by_text("Maroon V", 5)
```
## Full example<br>Полный пример
### 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<br>Документация
### 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/issamansur/vkpymusic",
"name": "vkpymusic",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.7",
"maintainer_email": null,
"keywords": "vk, api, music, downloader, python",
"author": "Issa Mansur (EDEXADE)",
"author_email": "issa_mansur@mail.ru",
"download_url": "https://files.pythonhosted.org/packages/3e/22/d3cb7c167730eba9d5c17e8eaba9217fc5066fb973a319ac5bd48f84995e/vkpymusic-3.3.1.tar.gz",
"platform": null,
"description": "\n\n\n\n# VKpyMusic \n### 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.\n### \u044d\u0442\u043e \u0431\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a\u0430 Python, \u043a\u043e\u0442\u043e\u0440\u0430\u044f \u043f\u0440\u0435\u0434\u043e\u0441\u0442\u0430\u0432\u043b\u044f\u0435\u0442 \u043f\u0440\u043e\u0441\u0442\u043e\u0439 \u0438\u043d\u0442\u0435\u0440\u0444\u0435\u0439\u0441 \u0434\u043b\u044f \u0432\u0437\u0430\u0438\u043c\u043e\u0434\u0435\u0439\u0441\u0442\u0432\u0438\u044f \u0441 API \u043c\u0443\u0437\u044b\u043a\u0430\u043b\u044c\u043d\u043e\u0433\u043e \u0441\u0435\u0440\u0432\u0438\u0441\u0430 \u0412\u041a\u043e\u043d\u0442\u0430\u043a\u0442\u0435 (VK). \u0411\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a\u0430 \u043f\u043e\u0437\u0432\u043e\u043b\u044f\u0435\u0442 \u0440\u0430\u0437\u0440\u0430\u0431\u043e\u0442\u0447\u0438\u043a\u0430\u043c \u043b\u0435\u0433\u043a\u043e \u0432\u044b\u043f\u043e\u043b\u043d\u044f\u0442\u044c \u043e\u043f\u0435\u0440\u0430\u0446\u0438\u0438, \u0441\u0432\u044f\u0437\u0430\u043d\u043d\u044b\u0435 \u0441 \u043c\u0443\u0437\u044b\u043a\u043e\u0439 \u0438 \u0434\u0440\u0443\u0433\u0438\u043c\u0438 \u0444\u0443\u043d\u043a\u0446\u0438\u043e\u043d\u0430\u043b\u044c\u043d\u044b\u043c\u0438 \u0432\u043e\u0437\u043c\u043e\u0436\u043d\u043e\u0441\u0442\u044f\u043c\u0438, \u0434\u043e\u0441\u0442\u0443\u043f\u043d\u044b\u043c\u0438 \u0447\u0435\u0440\u0435\u0437 VK API.\n\n# Installation\n### You can install VKpyMusic using the pip package manager. Open your command prompt or terminal and execute the following command:\n### \u0412\u044b \u043c\u043e\u0436\u0435\u0442\u0435 \u0443\u0441\u0442\u0430\u043d\u043e\u0432\u0438\u0442\u044c VKpyMusic \u0441 \u043f\u043e\u043c\u043e\u0449\u044c\u044e \u043c\u0435\u043d\u0435\u0434\u0436\u0435\u0440\u0430 \u043f\u0430\u043a\u0435\u0442\u043e\u0432 pip. \u041e\u0442\u043a\u0440\u043e\u0439\u0442\u0435 \u043a\u043e\u043c\u0430\u043d\u0434\u043d\u0443\u044e \u0441\u0442\u0440\u043e\u043a\u0443 \u0438\u043b\u0438 \u0442\u0435\u0440\u043c\u0438\u043d\u0430\u043b \u0438 \u0432\u044b\u043f\u043e\u043b\u043d\u0438\u0442\u0435 \u0441\u043b\u0435\u0434\u0443\u044e\u0449\u0443\u044e \u043a\u043e\u043c\u0430\u043d\u0434\u0443:\n\n### Console:\n```\npip install vkpymusic\n```\n\n# Usage\n### 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.\n### \u0427\u0442\u043e\u0431\u044b \u043d\u0430\u0447\u0430\u0442\u044c \u0440\u0430\u0431\u043e\u0442\u0443 \u0441 VKpyMusic, \u0432\u0430\u043c \u043f\u043e\u043d\u0430\u0434\u043e\u0431\u0438\u0442\u0441\u044f \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u0442\u0435\u043b\u044c\u043d\u044b\u0439 \u0442\u043e\u043a\u0435\u043d \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043a VK \u0438 \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c\u0441\u043a\u0438\u0439 \u0430\u0433\u0435\u043d\u0442, \u043a\u043e\u0442\u043e\u0440\u044b\u0439 \u043f\u0440\u0435\u0434\u043e\u0441\u0442\u0430\u0432\u043b\u044f\u0435\u0442 \u0434\u043e\u0441\u0442\u0443\u043f \u043a API \u043c\u0443\u0437\u044b\u043a\u0430\u043b\u044c\u043d\u043e\u0433\u043e \u0441\u0435\u0440\u0432\u0438\u0441\u0430 VK. \u041d\u043e \u0435\u0441\u043b\u0438 \u0443 \u0432\u0430\u0441 \u0438\u0445 \u043d\u0435\u0442, \u043d\u0438\u0447\u0435\u0433\u043e \u0441\u0442\u0440\u0430\u0448\u043d\u043e\u0433\u043e - \u0443 \u043d\u0430\u0441 \u0435\u0441\u0442\u044c \u0441\u0432\u043e\u0439 \u0441\u043e\u0431\u0441\u0442\u0432\u0435\u043d\u043d\u044b\u0439 \u043a\u043b\u0430\u0441\u0441, \u0447\u0442\u043e\u0431\u044b \u043f\u043e\u043b\u0443\u0447\u0438\u0442\u044c \u0438\u0445.\n\n## Example usage of VKpyMusic for receive token and user agent:<br>\u041f\u0440\u0438\u043c\u0435\u0440 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u044f VKpyMusic \u0434\u043b\u044f \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u0442\u043e\u043a\u0435\u043d\u0430 \u0438 \u044e\u0437\u0435\u0440-\u0430\u0433\u0435\u043d\u0442\u0430:\n### Python:\n```\nfrom vkpymusic import TokenReceiver\n\nlogin = input(\" Enter login: \")\npassword = input(\"Enter password: \")\n\ntokenReceiver = TokenReceiver(login, password)\n\nif tokenReceiver.auth():\n tokenReceiver.get_token()\n tokenReceiver.save_to_config()\n```\n### Result:\n```\n Enter login: +...........\nEnter password: .........\nSMS with a confirmation code has been sent to your phone! The code is valid for a few minutes!\nCode: 277765\nToken was received!\nToken was saved!\n```\n## Create an Service instance with your access token and user agent:<br>\u0421\u043e\u0437\u0434\u0430\u0439\u0442\u0435 \u044d\u043a\u0437\u0435\u043c\u043f\u043b\u044f\u0440 Service \u0441 \u0432\u0430\u0448\u0438\u043c \u0442\u043e\u043a\u0435\u043d\u043e\u043c \u0438 \u044e\u0437\u0435\u0440-\u0430\u0433\u0435\u043d\u0442\u043e\u043c:\n### Python:\n```\nfrom vkpymusic import Service\n\nservice = Service.parse_config()\n```\n## Or you can do like this:<br>\u0418\u043b\u0438 \u0412\u044b \u043c\u043e\u0436\u0435\u0442\u0435 \u0441\u0434\u0435\u043b\u0430\u0442\u044c \u0442\u0430\u043a:\n### Python:\n```\nservice = Service(\"<your_token>\", \"<your_client>\")\n```\n\n## Get information about the current user<br>\u041f\u043e\u043b\u0443\u0447\u0438\u0442\u044c \u0438\u043d\u0444\u043e\u0440\u043c\u0430\u0446\u0438\u044e \u043e \u043f\u0435\u0441\u043d\u044f\u0445 \u0442\u0435\u043a\u0443\u0449\u0435\u0433\u043e \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f\n### Python:\n```\nuser_songs = service.get_songs_by_userid(5, 10)\n```\n\n## Search for tracks by query<br>\u041f\u043e\u0438\u0441\u043a \u0442\u0440\u0435\u043a\u043e\u0432 \u043f\u043e \u0437\u0430\u043f\u0440\u043e\u0441\u0443\n### Python:\n```\nsongs = service.search_songs_by_text(\"Maroon V\", 5)\n```\n\n## Full example<br>\u041f\u043e\u043b\u043d\u044b\u0439 \u043f\u0440\u0438\u043c\u0435\u0440\n### Python:\n```\nfrom vkpymusic import Service, TokenReceiver\nlogin = input(\" Enter login: \")\npassword = input(\"Enter password: \")\n\ntokenReceiver = TokenReceiver(login, password)\n\nif tokenReceiver.auth():\n tokenReceiver.get_token()\n tokenReceiver.save_to_config()\n\nservice = Service.parse_config()\ntracks = service.search_songs_by_text('idfc tiktok remix')\nService.save_music(tracks[0])\n```\n\n# Documentation<br>\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f\n### Detailed documentation and usage examples for VKpyMusic can be found on the official project page on GitHub: \n### \u0414\u0435\u0442\u0430\u043b\u044c\u043d\u0430\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f \u0438 \u043f\u0440\u0438\u043c\u0435\u0440\u044b \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u044f \u0434\u043b\u044f VKpyMusic \u043d\u0430\u0445\u043e\u0434\u0438\u0442\u0441\u044f \u043d\u0430 \u043e\u0444\u0438\u0446\u0438\u0430\u043b\u044c\u043d\u043e\u0439 \u0441\u0442\u0440\u0430\u043d\u0438\u0446\u0435 \u043d\u0430 \u0413\u0438\u0442\u0425\u0430\u0431\u0435: \n## https://github.com/issamansur/vkpymusic\n## https://issamansur.github.io/vkpymusic/\n\n\n# Contributions and Support\n### \u0415\u0441\u043b\u0438 \u0443 \u0432\u0430\u0441 \u0435\u0441\u0442\u044c \u043a\u0430\u043a\u0438\u0435-\u043b\u0438\u0431\u043e \u043f\u0440\u0435\u0434\u043b\u043e\u0436\u0435\u043d\u0438\u044f \u043f\u043e \u0443\u043b\u0443\u0447\u0448\u0435\u043d\u0438\u044e VKpyMusic \u0438\u043b\u0438 \u0432\u044b \u043e\u0431\u043d\u0430\u0440\u0443\u0436\u0438\u0442\u0435 \u043a\u0430\u043a\u0438\u0435-\u043b\u0438\u0431\u043e \u043f\u0440\u043e\u0431\u043b\u0435\u043c\u044b, \u043f\u043e\u0436\u0430\u043b\u0443\u0439\u0441\u0442\u0430, \u0441\u043e\u0437\u0434\u0430\u0439\u0442\u0435 \u043d\u043e\u0432\u0443\u044e \u043f\u0440\u043e\u0431\u043b\u0435\u043c\u0443 \u043d\u0430 \u0441\u0442\u0440\u0430\u043d\u0438\u0446\u0435 \u043f\u0440\u043e\u0435\u043a\u0442\u0430 GitHub. \u041c\u044b \u043f\u0440\u0438\u0432\u0435\u0442\u0441\u0442\u0432\u0443\u0435\u043c \u0432\u0430\u0448\u0438 \u0437\u0430\u043f\u0440\u043e\u0441\u044b \u043d\u0430 \u0438\u0441\u043f\u0440\u0430\u0432\u043b\u0435\u043d\u0438\u044f \u0438 \u0433\u043e\u0442\u043e\u0432\u044b \u043f\u043e\u043c\u043e\u0447\u044c \u0432\u0430\u043c \u0441 \u043b\u044e\u0431\u044b\u043c\u0438 \u043f\u0440\u043e\u0431\u043b\u0435\u043c\u0430\u043c\u0438, \u0441 \u043a\u043e\u0442\u043e\u0440\u044b\u043c\u0438 \u0432\u044b \u0441\u0442\u043e\u043b\u043a\u043d\u0435\u0442\u0435\u0441\u044c.\n### 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.\n\n# License\n### VKpyMusic is distributed under the MIT license. For detailed information about the license, see the LICENSE file.\n\n# Authors\n### VKpyMusic is developed by the @issamansur or/and 'EDEXADE, inc.' development team.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python library for VK Audio (API)",
"version": "3.3.1",
"project_urls": {
"Homepage": "https://github.com/issamansur/vkpymusic",
"Repository": "https://github.com/issamansur/vkpymusic"
},
"split_keywords": [
"vk",
" api",
" music",
" downloader",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eec49a28ac4969deb9c34128a96e0b6977a312fd864a05af55a4f6c0608af91e",
"md5": "8833fbe915fe98fd907409beb66c0dba",
"sha256": "9ee27155d1895ccee91a20e0af8d78aa6a1f0d11df0988956ba8e2c87e0075e1"
},
"downloads": -1,
"filename": "vkpymusic-3.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8833fbe915fe98fd907409beb66c0dba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.7",
"size": 23470,
"upload_time": "2024-04-02T15:35:32",
"upload_time_iso_8601": "2024-04-02T15:35:32.861195Z",
"url": "https://files.pythonhosted.org/packages/ee/c4/9a28ac4969deb9c34128a96e0b6977a312fd864a05af55a4f6c0608af91e/vkpymusic-3.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e22d3cb7c167730eba9d5c17e8eaba9217fc5066fb973a319ac5bd48f84995e",
"md5": "c17e7f2a928ce06017e6560953dfbeea",
"sha256": "bc50bf32f2872ae1d8da32efaabae1734b70d8a9cfbae668497b292d8963d4b5"
},
"downloads": -1,
"filename": "vkpymusic-3.3.1.tar.gz",
"has_sig": false,
"md5_digest": "c17e7f2a928ce06017e6560953dfbeea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.7",
"size": 16032,
"upload_time": "2024-04-02T15:35:34",
"upload_time_iso_8601": "2024-04-02T15:35:34.815130Z",
"url": "https://files.pythonhosted.org/packages/3e/22/d3cb7c167730eba9d5c17e8eaba9217fc5066fb973a319ac5bd48f84995e/vkpymusic-3.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 15:35:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "issamansur",
"github_project": "vkpymusic",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.31"
]
]
},
{
"name": "aiofiles",
"specs": [
[
"==",
"23.2"
]
]
},
{
"name": "httpx",
"specs": [
[
"==",
"0.24"
]
]
}
],
"lcname": "vkpymusic"
}
JSON
