| Name | beets-mpd-utils JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | Beets plugins to interface with MPD |
| upload_time | 2023-11-27 16:36:03 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Hiroto Kaku 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 |
beets
mpd
music player daemon
music
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# beets-mpd-utils
Some [beets](https://beets.io/) plugins to interface with [Music Player Daemon](https://www.musicpd.org/).
- [MPD Tracker](#mpd-tracker): Track song plays/skips on MPD.
- [MPD DJ](#mpd-dj): Auto-add songs/albums to your MPD queue.
## Installation
Install the plugin.
**Note**: `mpd_tracker` requires a newer version of beets than is available on PyPI. Therefore, make sure it is installed from git.
```bash
pip install git+https://github.com/beetbox/beets.git beets-mpd-utils
```
Enable the plugin by adding it the `plugins` option in your beets config.
```yaml
plugins: mpd_tracker, mpd_dj
```
## Provided Plugins
### MPD Tracker
The `mpd_tracker` plugin tracks song plays and skips on MPD and records them in the following flexible attributes:
- Song
- `play_count`: The number of times the song has been played.
- `last_played`: When the `play_count` was last updated.
- `skip_count`: The number of times the song has beed skipped.
- Album
- `last_played`: Only written once every song in the album has been played. Defined as the oldest `last_played` value for the songs in the album.
#### Usage
Once enabled, start the tracker by typing:
```bash
beet tracker
```
#### Configuration
To configure, make a `mpd_tracker` section in your beets config file. Songs will be considered played/skipped if either of the time/percentage thresholds are met.
The available options are:
- **play_time**: The amount of seconds played after which the song will be considered "played". Default: `240`.
- **play_percent**: The percentage of the song that needs to be played before being considered "played". Expects a value between `0` and `1`, default: `0.5`.
- **skip_time**: The amount of seconds played before which the song will be considered "skipped". Default: `20`.
- **skip_percent**: The percentage of the song that needs to be played before which the song will be considered "skipped". Expects a value between `0` and `1`, default: `0.0`.
### MPD DJ
The `mpd_dj` plugin randomly adds items to the MPD queue. Note that activating this plugin will turn off random mode in MPD, as it needs to know what songs are upcoming in the queue.
#### Usage
Once enabled, start the tracker by typing:
```bash
beet dj
```
By default, the plugin will work to maintain 20 upcoming songs, selected randomly from the library. These defaults can be changed using command-line options.
- `--number=ITEMS`, `-n ITEMS`: The plugin will maintain the specified number of items in the upcoming queue.
- `--album`, `-a`: The plugin will queue albums instead of songs.
In addition, you can enter a [query](https://beets.readthedocs.io/en/stable/reference/query.html) to specify what will be added to the queue.
```bash
# maintain 5 albums in the queue, pulling randomly from albums released in 2022
beet dj -n 5 --album year:2022
```
Raw data
{
"_id": null,
"home_page": "",
"name": "beets-mpd-utils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "beets,MPD,music player daemon,music",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c4/e9/ed1d5d43172658617bdb4548d2fe1ea6c22ee015ed98829405dcb4ae8e58/beets-mpd-utils-0.1.3.tar.gz",
"platform": null,
"description": "# beets-mpd-utils\n\nSome [beets](https://beets.io/) plugins to interface with [Music Player Daemon](https://www.musicpd.org/).\n\n- [MPD Tracker](#mpd-tracker): Track song plays/skips on MPD.\n- [MPD DJ](#mpd-dj): Auto-add songs/albums to your MPD queue.\n\n## Installation\n\nInstall the plugin.\n\n**Note**: `mpd_tracker` requires a newer version of beets than is available on PyPI. Therefore, make sure it is installed from git.\n\n```bash\npip install git+https://github.com/beetbox/beets.git beets-mpd-utils\n```\n\nEnable the plugin by adding it the `plugins` option in your beets config.\n\n```yaml\nplugins: mpd_tracker, mpd_dj\n```\n\n## Provided Plugins\n\n### MPD Tracker\n\nThe `mpd_tracker` plugin tracks song plays and skips on MPD and records them in the following flexible attributes:\n\n- Song\n - `play_count`: The number of times the song has been played.\n - `last_played`: When the `play_count` was last updated.\n - `skip_count`: The number of times the song has beed skipped.\n- Album\n - `last_played`: Only written once every song in the album has been played. Defined as the oldest `last_played` value for the songs in the album.\n\n#### Usage\n\nOnce enabled, start the tracker by typing:\n\n```bash\nbeet tracker\n```\n\n#### Configuration\n\nTo configure, make a `mpd_tracker` section in your beets config file. Songs will be considered played/skipped if either of the time/percentage thresholds are met.\n\nThe available options are:\n\n- **play_time**: The amount of seconds played after which the song will be considered \"played\". Default: `240`.\n- **play_percent**: The percentage of the song that needs to be played before being considered \"played\". Expects a value between `0` and `1`, default: `0.5`.\n- **skip_time**: The amount of seconds played before which the song will be considered \"skipped\". Default: `20`.\n- **skip_percent**: The percentage of the song that needs to be played before which the song will be considered \"skipped\". Expects a value between `0` and `1`, default: `0.0`.\n\n### MPD DJ\n\nThe `mpd_dj` plugin randomly adds items to the MPD queue. Note that activating this plugin will turn off random mode in MPD, as it needs to know what songs are upcoming in the queue.\n\n#### Usage\n\nOnce enabled, start the tracker by typing:\n\n```bash\nbeet dj\n```\n\nBy default, the plugin will work to maintain 20 upcoming songs, selected randomly from the library. These defaults can be changed using command-line options.\n\n- `--number=ITEMS`, `-n ITEMS`: The plugin will maintain the specified number of items in the upcoming queue.\n- `--album`, `-a`: The plugin will queue albums instead of songs.\n\nIn addition, you can enter a [query](https://beets.readthedocs.io/en/stable/reference/query.html) to specify what will be added to the queue.\n\n```bash\n# maintain 5 albums in the queue, pulling randomly from albums released in 2022\nbeet dj -n 5 --album year:2022\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Hiroto Kaku 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": "Beets plugins to interface with MPD",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/thekakkun/beets-mpd-utils",
"Repository": "https://github.com/thekakkun/beets-mpd-utils.git"
},
"split_keywords": [
"beets",
"mpd",
"music player daemon",
"music"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "322e49f84330866f16a9c3f10ba6290e441b9a75857420cccec6931f080930c3",
"md5": "943286daca433a6ad5ca4ace4755a394",
"sha256": "e7a271d19374ee0fb3b7110bbc22a73277b70719df3d9508facdc09f3da2967c"
},
"downloads": -1,
"filename": "beets_mpd_utils-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "943286daca433a6ad5ca4ace4755a394",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9378,
"upload_time": "2023-11-27T16:36:02",
"upload_time_iso_8601": "2023-11-27T16:36:02.805219Z",
"url": "https://files.pythonhosted.org/packages/32/2e/49f84330866f16a9c3f10ba6290e441b9a75857420cccec6931f080930c3/beets_mpd_utils-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4e9ed1d5d43172658617bdb4548d2fe1ea6c22ee015ed98829405dcb4ae8e58",
"md5": "4272a1b8ff1fc04530b0c17ee08dd2b3",
"sha256": "2f15201994615dbb407ea8e23fcbd0b9321f3bfffc767a5c26e23314f5b17f47"
},
"downloads": -1,
"filename": "beets-mpd-utils-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "4272a1b8ff1fc04530b0c17ee08dd2b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7698,
"upload_time": "2023-11-27T16:36:03",
"upload_time_iso_8601": "2023-11-27T16:36:03.818905Z",
"url": "https://files.pythonhosted.org/packages/c4/e9/ed1d5d43172658617bdb4548d2fe1ea6c22ee015ed98829405dcb4ae8e58/beets-mpd-utils-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-27 16:36:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thekakkun",
"github_project": "beets-mpd-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "beets-mpd-utils"
}
