spotrpy


Namespotrpy JSON
Version 4.1 PyPI version JSON
download
home_pagehttps://github.com/Havard03/spotr
SummaryA simple spotify tool for the terminal
upload_time2024-08-16 08:35:13
maintainerNone
docs_urlNone
authorHavard03
requires_python>=3.6
licenseNone
keywords cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
<h1 align="center">Spotr - A spotify tool for the terminal</h1>

<p align="center">
 <a href="https://github.com/Havard03/spotr/graphs/contributors">
  <img src="https://img.shields.io/github/contributors/Havard03/spotr.svg?style=for-the-badge"></a>
 <a href="https://github.com/Havard03/spotr/network/members">
  <img src="https://img.shields.io/github/forks/Havard03/spotr.svg?style=for-the-badge"></a>
 <a href="https://github.com/Havard03/spotr/stargazers">
  <img src="https://img.shields.io/github/stars/Havard03/spotr.svg?style=for-the-badge"></a>
 <a href="https://github.com/Havard03/spotr/issues">
  <img src="https://img.shields.io/github/issues/Havard03/spotr.svg?style=for-the-badge"></a>
 <a href="https://github.com/Havard03/spotr/blob/master/LICENSE.txt">
  <img src="https://img.shields.io/github/license/Havard03/spotr.svg?style=for-the-badge"></a>
</p>

<p align="center">
A very simple CLI for controlling your spotify on the fly in the terminal. Made in python for simplicity
</p>

<img align="center" width="100%" src="https://github.com/user-attachments/assets/24094f70-4eae-4bd6-b0ae-06e5cab82c4a">

<h1 align="center" style="border-bottom: none">Debug</h1>

<img align="center" width="100%" src="https://github.com/user-attachments/assets/d53164f4-180d-4513-b2f1-0b34dd1f93bb">

<h1 align="center" style="border-bottom: none">Argparser</h1>

<img align="center" width="100%" src="https://github.com/Havard03/spotr/assets/58250866/c19ef190-7d01-4b78-9891-102efd9d61d7">

<h1 align="center" style="border-bottom: none">Installation</h1>

```
$ pip install spotrpy
```
Or clone the repo and install locally
```
$ pip install -e .
```

2. Register an app in spotify for developers "https://developer.spotify.com/dashboard/applications"
   - Also set callback URI to "https://www.google.com/"

3. Run any spotr command (If command is not recognized check if python bin is in PATH)

4. You will be prompted to create config.json and paste in client and secret id from spotify app

5. After these steps everything should work and you can enjoy spotr

</p>

<h1 align="center" style="border-bottom: none">Built-in Commands</h1>

    auth                Authorize Spotify api
    authorize           Authorize Spotify api
    artist              Display artist information
    ascii               Ascii image for current track
    current             Display information about the currently playing track
    next                Play next track
    playback            Set playback state
    playlist            Start playing one of your playlists
    playlistadd         Add currently playing track to a playlist
    previous            Play previous track
    qsearch             Quicksearch for tracks
    queue               Display current queue
    recent              Select one of recently played tracks
    recommend           Play random / recommended tracks based on recent tracks
    replay              Replay/Restart currently playing track
    search              Search for anything on spotify, Types - track, playlist, album
    seek                Seek posistion for track (in seconds)
    shuffle             Toggle shuffle, on / off
    start               Start/resume playing
    resume              Start/resume playing
    stop                Stop/Pause playing
    pause               Stop/Pause playing
    volume              Ajust volume
    vol                 Ajust volume
    web                 Open currently playing track in a broswer

<h1 align="center" style="border-bottom: none">Modifications</h1>
<p>

Commands are declared in commands.py, Then you can set any function or class-method as callable.

<h4><a href="https://developer.spotify.com/documentation/web-api">API documentation</a></h4>

</p>



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Havard03/spotr",
    "name": "spotrpy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "cli",
    "author": "Havard03",
    "author_email": "havard.buvang@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d3/51/92137548f071be18e6b75f12eadb1db71ea09e4d61947d53676279322ccc/spotrpy-4.1.tar.gz",
    "platform": null,
    "description": "\n<h1 align=\"center\">Spotr - A spotify tool for the terminal</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/Havard03/spotr/graphs/contributors\">\n  <img src=\"https://img.shields.io/github/contributors/Havard03/spotr.svg?style=for-the-badge\"></a>\n <a href=\"https://github.com/Havard03/spotr/network/members\">\n  <img src=\"https://img.shields.io/github/forks/Havard03/spotr.svg?style=for-the-badge\"></a>\n <a href=\"https://github.com/Havard03/spotr/stargazers\">\n  <img src=\"https://img.shields.io/github/stars/Havard03/spotr.svg?style=for-the-badge\"></a>\n <a href=\"https://github.com/Havard03/spotr/issues\">\n  <img src=\"https://img.shields.io/github/issues/Havard03/spotr.svg?style=for-the-badge\"></a>\n <a href=\"https://github.com/Havard03/spotr/blob/master/LICENSE.txt\">\n  <img src=\"https://img.shields.io/github/license/Havard03/spotr.svg?style=for-the-badge\"></a>\n</p>\n\n<p align=\"center\">\nA very simple CLI for controlling your spotify on the fly in the terminal. Made in python for simplicity\n</p>\n\n<img align=\"center\" width=\"100%\" src=\"https://github.com/user-attachments/assets/24094f70-4eae-4bd6-b0ae-06e5cab82c4a\">\n\n<h1 align=\"center\" style=\"border-bottom: none\">Debug</h1>\n\n<img align=\"center\" width=\"100%\" src=\"https://github.com/user-attachments/assets/d53164f4-180d-4513-b2f1-0b34dd1f93bb\">\n\n<h1 align=\"center\" style=\"border-bottom: none\">Argparser</h1>\n\n<img align=\"center\" width=\"100%\" src=\"https://github.com/Havard03/spotr/assets/58250866/c19ef190-7d01-4b78-9891-102efd9d61d7\">\n\n<h1 align=\"center\" style=\"border-bottom: none\">Installation</h1>\n\n```\n$ pip install spotrpy\n```\nOr clone the repo and install locally\n```\n$ pip install -e .\n```\n\n2. Register an app in spotify for developers \"https://developer.spotify.com/dashboard/applications\"\n   - Also set callback URI to \"https://www.google.com/\"\n\n3. Run any spotr command (If command is not recognized check if python bin is in PATH)\n\n4. You will be prompted to create config.json and paste in client and secret id from spotify app\n\n5. After these steps everything should work and you can enjoy spotr\n\n</p>\n\n<h1 align=\"center\" style=\"border-bottom: none\">Built-in Commands</h1>\n\n    auth                Authorize Spotify api\n    authorize           Authorize Spotify api\n    artist              Display artist information\n    ascii               Ascii image for current track\n    current             Display information about the currently playing track\n    next                Play next track\n    playback            Set playback state\n    playlist            Start playing one of your playlists\n    playlistadd         Add currently playing track to a playlist\n    previous            Play previous track\n    qsearch             Quicksearch for tracks\n    queue               Display current queue\n    recent              Select one of recently played tracks\n    recommend           Play random / recommended tracks based on recent tracks\n    replay              Replay/Restart currently playing track\n    search              Search for anything on spotify, Types - track, playlist, album\n    seek                Seek posistion for track (in seconds)\n    shuffle             Toggle shuffle, on / off\n    start               Start/resume playing\n    resume              Start/resume playing\n    stop                Stop/Pause playing\n    pause               Stop/Pause playing\n    volume              Ajust volume\n    vol                 Ajust volume\n    web                 Open currently playing track in a broswer\n\n<h1 align=\"center\" style=\"border-bottom: none\">Modifications</h1>\n<p>\n\nCommands are declared in commands.py, Then you can set any function or class-method as callable.\n\n<h4><a href=\"https://developer.spotify.com/documentation/web-api\">API documentation</a></h4>\n\n</p>\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simple spotify tool for the terminal",
    "version": "4.1",
    "project_urls": {
        "Homepage": "https://github.com/Havard03/spotr"
    },
    "split_keywords": [
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ac6e22c8a2c815d0f3bacb62e4aaeb3e334c8cb5b188676449f6415d16cdd200",
                "md5": "2fc2f9cc4aaa7c370f04ddc679bd420e",
                "sha256": "f283beb8dec31327e3fd6caf719df2035ca66990f244b2b78ef2e1d5ddf00ada"
            },
            "downloads": -1,
            "filename": "spotrpy-4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2fc2f9cc4aaa7c370f04ddc679bd420e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 26030,
            "upload_time": "2024-08-16T08:35:11",
            "upload_time_iso_8601": "2024-08-16T08:35:11.828707Z",
            "url": "https://files.pythonhosted.org/packages/ac/6e/22c8a2c815d0f3bacb62e4aaeb3e334c8cb5b188676449f6415d16cdd200/spotrpy-4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d35192137548f071be18e6b75f12eadb1db71ea09e4d61947d53676279322ccc",
                "md5": "da370bb6ebee24f936fe8cc02f02b4f9",
                "sha256": "44d19bacf815a822c7c1d26f757d735eee9c5c19e358ac522e2b80126061bccd"
            },
            "downloads": -1,
            "filename": "spotrpy-4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "da370bb6ebee24f936fe8cc02f02b4f9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 16002,
            "upload_time": "2024-08-16T08:35:13",
            "upload_time_iso_8601": "2024-08-16T08:35:13.760329Z",
            "url": "https://files.pythonhosted.org/packages/d3/51/92137548f071be18e6b75f12eadb1db71ea09e4d61947d53676279322ccc/spotrpy-4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-16 08:35:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Havard03",
    "github_project": "spotr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "spotrpy"
}
        
Elapsed time: 1.68859s