{"id":18733916,"url":"https://github.com/mgoltzsche/beets-websearch","last_synced_at":"2025-08-01T05:35:22.428Z","repository":{"id":248781592,"uuid":"828625359","full_name":"mgoltzsche/beets-websearch","owner":"mgoltzsche","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-13T16:02:37.000Z","size":49,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-28T15:49:39.281Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mgoltzsche.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-14T17:51:02.000Z","updated_at":"2024-12-13T16:02:16.000Z","dependencies_parsed_at":"2024-07-17T04:08:24.430Z","dependency_job_id":"bacb7ca5-321b-4c3c-a4ab-315352d03563","html_url":"https://github.com/mgoltzsche/beets-websearch","commit_stats":null,"previous_names":["mgoltzsche/beets-websearch"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgoltzsche%2Fbeets-websearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgoltzsche%2Fbeets-websearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgoltzsche%2Fbeets-websearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgoltzsche%2Fbeets-websearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mgoltzsche","download_url":"https://codeload.github.com/mgoltzsche/beets-websearch/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239605079,"owners_count":19667004,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T15:11:46.838Z","updated_at":"2025-02-19T06:16:49.192Z","avatar_url":"https://github.com/mgoltzsche.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# beets-websearch\n\nA [beets](https://github.com/beetbox/beets) plugin to search tracks and save the result as playlists via HTTP.\n\n## Features\n\n* Provides a JSON REST API to search tracks.\n* Allows to save searches as playlists.\n\n## Installation\n\n```sh\npython3 -m pip install beets-websearch\n```\n\n## Configuration\n\nEnable the plugin and add a `websearch` section to your beets `config.yaml` as follows:\n```yaml\nplugins:\n  - websearch\n\nwebsearch\n  host: '127.0.0.1'\n  port: 5000\n```\n\n## Usage\n\nOnce the `websearch` plugin is enabled within your beets configuration, you can run it as follows:\n```sh\nbeet websearch\n```\n\nYou can browse the server at [`http://127.0.0.1:5000`](http://127.0.0.1:5000).\n\nTo serve multiple beets web APIs using a single process, you can use the [webrouter plugin](https://github.com/mgoltzsche/beets-webrouter).\n\n### CLI\n\n```\nUsage: beet websearch [options]\n\nOptions:\n  -h, --help   show this help message and exit\n  -d, --debug  debug mode\n```\n\n## Web API\n\nSee [OpenAPI definition](./openapi.yaml).\n\n## Development\n\nThe following assumes you have [docker](https://docs.docker.com/engine/install/) installed.\n\nIn case you make changes to the [`openapi.yaml`](./openapi.yaml), you can validate them as follows:\n```sh\nmake validate-openapi\n```\n\nGenerate the server stub from the [openapi.yaml](./openapi.yaml) (containerized):\n```sh\nmake generate\n```\n\nRun the unit tests (containerized):\n```sh\nmake test\n```\n\nRun the e2e tests (containerized):\n```sh\nmake test-e2e\n```\n\nTo test your plugin changes manually, you can run a shell within a beets docker container as follows:\n```sh\nmake beets-sh\n```\n\nA temporary beets library is written to `./data`.\nIt can be removed by calling `make clean-data`.\n\nTo download example data, run:\n```sh\nmake example-data\n```\n\nTo just start the server, run:\n```sh\nmake beets-websearch\n```\n\nNow you can browse the executable API documentation at [`http://127.0.0.1:5000/docs`](http://127.0.0.1:5000/docs).\n\nExample API call to search tracks: [`http://127.0.0.1:5000/tracks?query={%22artist%22:{%22contains%22:%20%22dengue%22},%22title%22:{%22contains%22:%22serpiente%22}}`](http://127.0.0.1:5000/tracks?query={%22artist%22:{%22contains%22:%20%22dengue%22},%22title%22:{%22contains%22:%22serpiente%22}}).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgoltzsche%2Fbeets-websearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmgoltzsche%2Fbeets-websearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgoltzsche%2Fbeets-websearch/lists"}