| Name | ytmusicapi JSON |
| Version |
1.9.0
JSON |
| download |
| home_page | None |
| Summary | Unofficial API for YouTube Music |
| upload_time | 2024-12-17 21:43:22 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 sigma67 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
ytmusicapi: Unofficial API for YouTube Music
############################################
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/ytmusicapi?style=flat-square
:alt: PyPI Downloads
:target: https://pypi.org/project/ytmusicapi/
.. |gitter| image:: https://badges.gitter.im/sigma67/ytmusicapi.svg
:alt: Ask questions at https://gitter.im/sigma67/ytmusicapi
:target: https://gitter.im/sigma67/ytmusicapi
.. |code-coverage| image:: https://img.shields.io/codecov/c/github/sigma67/ytmusicapi?style=flat-square
:alt: Code coverage
:target: https://codecov.io/gh/sigma67/ytmusicapi
.. |latest-release| image:: https://img.shields.io/github/v/release/sigma67/ytmusicapi?style=flat-square
:alt: Latest release
:target: https://github.com/sigma67/ytmusicapi/releases/latest
.. |commits-since-latest| image:: https://img.shields.io/github/commits-since/sigma67/ytmusicapi/latest?style=flat-square
:alt: Commits since latest release
:target: https://github.com/sigma67/ytmusicapi/commits
|pypi-downloads| |gitter| |code-coverage| |latest-release| |commits-since-latest|
ytmusicapi is a Python 3 library to send requests to the YouTube Music API.
It emulates YouTube Music web client requests using the user's cookie data for authentication.
.. features
Features
--------
| **Browsing**:
* search (including all filters) and suggestions
* get artist information and releases (songs, videos, albums, singles, related artists)
* get user information (videos, playlists)
* get albums
* get song metadata
* get watch playlists (next songs when you press play/radio/shuffle in YouTube Music)
* get song lyrics
| **Exploring music**:
* get moods and genres playlists
* get latest charts (globally and per country)
| **Library management**:
* get library contents: playlists, songs, artists, albums and subscriptions, podcasts, channels
* add/remove library content: rate songs, albums and playlists, subscribe/unsubscribe artists
* get and modify play history
| **Playlists**:
* create and delete playlists
* modify playlists: edit metadata, add/move/remove tracks
* get playlist contents
* get playlist suggestions
| **Podcasts**:
* get podcasts
* get episodes
* get channels
* get episodes playlists
| **Uploads**:
* upload songs and remove them again
* list uploaded songs, artists and albums
| **Localization**:
* all regions are supported (see `locations FAQ <https://ytmusicapi.readthedocs.io/en/stable/faq.html#which-values-can-i-use-for-locations>`__
* 16 languages are supported (see `languages FAQ <https://ytmusicapi.readthedocs.io/en/stable/faq.html#which-values-can-i-use-for-languages>`__
If you find something missing or broken,
check the `FAQ <https://ytmusicapi.readthedocs.io/en/stable/faq.html>`__ or
feel free to create an `issue <https://github.com/sigma67/ytmusicapi/issues/new/choose>`__.
Requirements
------------
- Python 3.9 or higher - https://www.python.org
Setup
-----
See the `Documentation <https://ytmusicapi.readthedocs.io/en/stable/usage.html>`_ for detailed instructions
Usage
------
.. code-block:: python
from ytmusicapi import YTMusic
yt = YTMusic('oauth.json')
playlistId = yt.create_playlist('test', 'test description')
search_results = yt.search('Oasis Wonderwall')
yt.add_playlist_items(playlistId, [search_results[0]['videoId']])
The `tests <https://github.com/sigma67/ytmusicapi/blob/master/tests/>`_ are also a great source of usage examples.
.. end-features
Contributing
------------
Pull requests are welcome. There are still some features that are not yet implemented.
Please, refer to `CONTRIBUTING.rst <https://github.com/sigma67/ytmusicapi/blob/master/CONTRIBUTING.rst>`_ for guidance.
Raw data
{
"_id": null,
"home_page": null,
"name": "ytmusicapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "sigma67 <ytmusicapi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/64/2a/b5a3b1a3ce0bc2f6e2628c239e48019d7313dfabae595842eb10f875506a/ytmusicapi-1.9.0.tar.gz",
"platform": null,
"description": "ytmusicapi: Unofficial API for YouTube Music\n############################################\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/ytmusicapi?style=flat-square\n :alt: PyPI Downloads\n :target: https://pypi.org/project/ytmusicapi/\n\n.. |gitter| image:: https://badges.gitter.im/sigma67/ytmusicapi.svg\n :alt: Ask questions at https://gitter.im/sigma67/ytmusicapi\n :target: https://gitter.im/sigma67/ytmusicapi\n\n.. |code-coverage| image:: https://img.shields.io/codecov/c/github/sigma67/ytmusicapi?style=flat-square\n :alt: Code coverage\n :target: https://codecov.io/gh/sigma67/ytmusicapi\n\n.. |latest-release| image:: https://img.shields.io/github/v/release/sigma67/ytmusicapi?style=flat-square\n :alt: Latest release\n :target: https://github.com/sigma67/ytmusicapi/releases/latest\n\n.. |commits-since-latest| image:: https://img.shields.io/github/commits-since/sigma67/ytmusicapi/latest?style=flat-square\n :alt: Commits since latest release\n :target: https://github.com/sigma67/ytmusicapi/commits\n\n\n|pypi-downloads| |gitter| |code-coverage| |latest-release| |commits-since-latest|\n\nytmusicapi is a Python 3 library to send requests to the YouTube Music API.\nIt emulates YouTube Music web client requests using the user's cookie data for authentication.\n\n.. features\n\nFeatures\n--------\n\n| **Browsing**:\n\n* search (including all filters) and suggestions\n* get artist information and releases (songs, videos, albums, singles, related artists)\n* get user information (videos, playlists)\n* get albums\n* get song metadata\n* get watch playlists (next songs when you press play/radio/shuffle in YouTube Music)\n* get song lyrics\n\n| **Exploring music**:\n\n* get moods and genres playlists\n* get latest charts (globally and per country)\n\n| **Library management**:\n\n* get library contents: playlists, songs, artists, albums and subscriptions, podcasts, channels\n* add/remove library content: rate songs, albums and playlists, subscribe/unsubscribe artists\n* get and modify play history\n\n| **Playlists**:\n\n* create and delete playlists\n* modify playlists: edit metadata, add/move/remove tracks\n* get playlist contents\n* get playlist suggestions\n\n| **Podcasts**:\n\n* get podcasts\n* get episodes\n* get channels\n* get episodes playlists\n\n| **Uploads**:\n\n* upload songs and remove them again\n* list uploaded songs, artists and albums\n\n| **Localization**:\n\n* all regions are supported (see `locations FAQ <https://ytmusicapi.readthedocs.io/en/stable/faq.html#which-values-can-i-use-for-locations>`__\n* 16 languages are supported (see `languages FAQ <https://ytmusicapi.readthedocs.io/en/stable/faq.html#which-values-can-i-use-for-languages>`__\n\n\nIf you find something missing or broken,\ncheck the `FAQ <https://ytmusicapi.readthedocs.io/en/stable/faq.html>`__ or\nfeel free to create an `issue <https://github.com/sigma67/ytmusicapi/issues/new/choose>`__.\n\nRequirements\n------------\n\n- Python 3.9 or higher - https://www.python.org\n\nSetup\n-----\n\nSee the `Documentation <https://ytmusicapi.readthedocs.io/en/stable/usage.html>`_ for detailed instructions\n\nUsage\n------\n.. code-block:: python\n\n from ytmusicapi import YTMusic\n\n yt = YTMusic('oauth.json')\n playlistId = yt.create_playlist('test', 'test description')\n search_results = yt.search('Oasis Wonderwall')\n yt.add_playlist_items(playlistId, [search_results[0]['videoId']])\n\nThe `tests <https://github.com/sigma67/ytmusicapi/blob/master/tests/>`_ are also a great source of usage examples.\n\n.. end-features\n\nContributing\n------------\n\nPull requests are welcome. There are still some features that are not yet implemented.\nPlease, refer to `CONTRIBUTING.rst <https://github.com/sigma67/ytmusicapi/blob/master/CONTRIBUTING.rst>`_ for guidance.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 sigma67 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Unofficial API for YouTube Music",
"version": "1.9.0",
"project_urls": {
"documentation": "https://ytmusicapi.readthedocs.io",
"homepage": "https://github.com/sigma67/ytmusicapi",
"repository": "https://github.com/sigma67/ytmusicapi"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef1f40d6324eb6b171d3913d9a776a6e6a6b5ba9415e7e41dd3d9bd6bc59ac7c",
"md5": "3489901ba2c46330291723ae00eefa63",
"sha256": "957c7a8c688f3675644648807255241940e557bf6e79b39c943f3e7e8c961186"
},
"downloads": -1,
"filename": "ytmusicapi-1.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3489901ba2c46330291723ae00eefa63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 91300,
"upload_time": "2024-12-17T21:43:19",
"upload_time_iso_8601": "2024-12-17T21:43:19.302706Z",
"url": "https://files.pythonhosted.org/packages/ef/1f/40d6324eb6b171d3913d9a776a6e6a6b5ba9415e7e41dd3d9bd6bc59ac7c/ytmusicapi-1.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "642ab5a3b1a3ce0bc2f6e2628c239e48019d7313dfabae595842eb10f875506a",
"md5": "ca68ce82f1d3eea0ca7f5930eb911785",
"sha256": "1f703ba5c9c09208cd124b9feb578d9ab39e558b6ca457ac037ea65e7db9b16c"
},
"downloads": -1,
"filename": "ytmusicapi-1.9.0.tar.gz",
"has_sig": false,
"md5_digest": "ca68ce82f1d3eea0ca7f5930eb911785",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 292697,
"upload_time": "2024-12-17T21:43:22",
"upload_time_iso_8601": "2024-12-17T21:43:22.252464Z",
"url": "https://files.pythonhosted.org/packages/64/2a/b5a3b1a3ce0bc2f6e2628c239e48019d7313dfabae595842eb10f875506a/ytmusicapi-1.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 21:43:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sigma67",
"github_project": "ytmusicapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ytmusicapi"
}
