tekore


Nametekore JSON
Version 5.5.0 PyPI version JSON
download
home_pageNone
SummaryClient for the Spotify Web API
upload_time2024-07-04 17:43:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2019-2023 Felix Hildén 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 spotify web api client
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            |logo|

|python| |downloads|

Welcome to the Python Package Index page of Tekore!
We provide a client for the Spotify Web API for Python,
complete with all available endpoints and authentication methods,
async support and loads of additional features.
Tekore allows you to interact with the API effortlessly.
Here's five lines to get you full access and start playing your top songs.

.. code:: python

    import tekore as tk

    conf = (client_id, client_secret, redirect_uri)
    token = tk.prompt_for_user_token(*conf, scope=tk.scope.every)

    spotify = tk.Spotify(token)
    tracks = spotify.current_user_top_tracks(limit=10)
    spotify.playback_start_tracks([t.id for t in tracks.items])

See our online documentation on `Read The Docs`_ for tutorials,
examples, package reference and a detailed description of features.
If you've found a bug or would like to propose a feature,
please submit an issue on `GitHub`_.
Join our `Discord <https://discord.gg/wcRXgJu>`_ community
to ask for help or discuss just about anything related to Tekore.
You can also ask a question on
`Stack Overflow <https://stackoverflow.com/questions/tagged/tekore>`_.

Installation
============
Tekore can be installed from the Package Index via ``pip``.

.. code:: sh

    $ pip install tekore

Changelog
=========
A detailed changelog can be found on our RTD documentation's
`Release notes <https://tekore.readthedocs.io/page/release_notes.html>`_.

Versioning
==========
When requiring Tekore in projects or other packages,
please pin the version down to at least a specific major release
to avoid compatibility issues.
For example:

.. code:: python

    setup(
        install_requires=[
            'tekore~=4.0'
        ]
    )

Tekore provides both stable and beta endpoints of the Web API.
However, beta endpoints may be changed by Spotify without prior notice,
so older versions of the library may have unintended issues.
Because of this, Tekore follows a modified form of
`Semantic Versioning <https://semver.org/>`_.
Incompatible changes in the library are still introduced in major versions,
and new features and endpoints are added in minor versions.
But endpoints removed by Spotify are removed in minor versions and changes
to endpoints are implemented as bugfixes.
See the Web API `documentation <web api_>`_ for further information on beta endpoints.


.. |logo| image:: https://raw.githubusercontent.com/felix-hilden/tekore/master/docs/src/logo_small.png
   :alt: logo

.. |python| image:: https://img.shields.io/pypi/pyversions/tekore
   :alt: python version

.. |downloads| image:: https://pepy.tech/badge/tekore/month
   :alt: monthly downloads

.. _github: https://github.com/felix-hilden/tekore
.. _read the docs: https://tekore.readthedocs.io
.. _web api: https://developer.spotify.com/documentation/web-api

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tekore",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Felix Hild\u00e9n <felix.hilden@gmail.com>",
    "keywords": "spotify, web, api, client",
    "author": null,
    "author_email": "Felix Hild\u00e9n <felix.hilden@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/8d/06/15a6705b981cdac6844a80d9e8da073e1c72295805d96c5bbf0f4c601132/tekore-5.5.0.tar.gz",
    "platform": null,
    "description": "|logo|\r\n\r\n|python| |downloads|\r\n\r\nWelcome to the Python Package Index page of Tekore!\r\nWe provide a client for the Spotify Web API for Python,\r\ncomplete with all available endpoints and authentication methods,\r\nasync support and loads of additional features.\r\nTekore allows you to interact with the API effortlessly.\r\nHere's five lines to get you full access and start playing your top songs.\r\n\r\n.. code:: python\r\n\r\n    import tekore as tk\r\n\r\n    conf = (client_id, client_secret, redirect_uri)\r\n    token = tk.prompt_for_user_token(*conf, scope=tk.scope.every)\r\n\r\n    spotify = tk.Spotify(token)\r\n    tracks = spotify.current_user_top_tracks(limit=10)\r\n    spotify.playback_start_tracks([t.id for t in tracks.items])\r\n\r\nSee our online documentation on `Read The Docs`_ for tutorials,\r\nexamples, package reference and a detailed description of features.\r\nIf you've found a bug or would like to propose a feature,\r\nplease submit an issue on `GitHub`_.\r\nJoin our `Discord <https://discord.gg/wcRXgJu>`_ community\r\nto ask for help or discuss just about anything related to Tekore.\r\nYou can also ask a question on\r\n`Stack Overflow <https://stackoverflow.com/questions/tagged/tekore>`_.\r\n\r\nInstallation\r\n============\r\nTekore can be installed from the Package Index via ``pip``.\r\n\r\n.. code:: sh\r\n\r\n    $ pip install tekore\r\n\r\nChangelog\r\n=========\r\nA detailed changelog can be found on our RTD documentation's\r\n`Release notes <https://tekore.readthedocs.io/page/release_notes.html>`_.\r\n\r\nVersioning\r\n==========\r\nWhen requiring Tekore in projects or other packages,\r\nplease pin the version down to at least a specific major release\r\nto avoid compatibility issues.\r\nFor example:\r\n\r\n.. code:: python\r\n\r\n    setup(\r\n        install_requires=[\r\n            'tekore~=4.0'\r\n        ]\r\n    )\r\n\r\nTekore provides both stable and beta endpoints of the Web API.\r\nHowever, beta endpoints may be changed by Spotify without prior notice,\r\nso older versions of the library may have unintended issues.\r\nBecause of this, Tekore follows a modified form of\r\n`Semantic Versioning <https://semver.org/>`_.\r\nIncompatible changes in the library are still introduced in major versions,\r\nand new features and endpoints are added in minor versions.\r\nBut endpoints removed by Spotify are removed in minor versions and changes\r\nto endpoints are implemented as bugfixes.\r\nSee the Web API `documentation <web api_>`_ for further information on beta endpoints.\r\n\r\n\r\n.. |logo| image:: https://raw.githubusercontent.com/felix-hilden/tekore/master/docs/src/logo_small.png\r\n   :alt: logo\r\n\r\n.. |python| image:: https://img.shields.io/pypi/pyversions/tekore\r\n   :alt: python version\r\n\r\n.. |downloads| image:: https://pepy.tech/badge/tekore/month\r\n   :alt: monthly downloads\r\n\r\n.. _github: https://github.com/felix-hilden/tekore\r\n.. _read the docs: https://tekore.readthedocs.io\r\n.. _web api: https://developer.spotify.com/documentation/web-api\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2019-2023 Felix Hild\u00e9n  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": "Client for the Spotify Web API",
    "version": "5.5.0",
    "project_urls": {
        "Documentation": "https://tekore.rtfd.org",
        "Download": "https://pypi.org/project/tekore",
        "Homepage": "https://pypi.org/project/tekore",
        "Issues": "https://github.com/felix-hilden/tekore/issues",
        "Source": "https://github.com/felix-hilden/tekore"
    },
    "split_keywords": [
        "spotify",
        " web",
        " api",
        " client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4d1d79c6f0d5b86769b3985b8575b723a18ebedbed7dbd51be260cff7c237871",
                "md5": "50ba5234ab20163433990012d09bd136",
                "sha256": "0b5445db7d34e3094f942f20530455a7d1a81c2b897099c873cc2b6b2ecd1877"
            },
            "downloads": -1,
            "filename": "tekore-5.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "50ba5234ab20163433990012d09bd136",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 75166,
            "upload_time": "2024-07-04T17:43:43",
            "upload_time_iso_8601": "2024-07-04T17:43:43.289976Z",
            "url": "https://files.pythonhosted.org/packages/4d/1d/79c6f0d5b86769b3985b8575b723a18ebedbed7dbd51be260cff7c237871/tekore-5.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8d0615a6705b981cdac6844a80d9e8da073e1c72295805d96c5bbf0f4c601132",
                "md5": "f11f541f5f247b223851e3dc7966e5b1",
                "sha256": "99e090f52f429d15e4ad9d77ff060e432cb94ab90926e25149f31dea00a53bcc"
            },
            "downloads": -1,
            "filename": "tekore-5.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f11f541f5f247b223851e3dc7966e5b1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 270803,
            "upload_time": "2024-07-04T17:43:45",
            "upload_time_iso_8601": "2024-07-04T17:43:45.852861Z",
            "url": "https://files.pythonhosted.org/packages/8d/06/15a6705b981cdac6844a80d9e8da073e1c72295805d96c5bbf0f4c601132/tekore-5.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-04 17:43:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "felix-hilden",
    "github_project": "tekore",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "tekore"
}
        
Elapsed time: 1.02282s