{"id":19662369,"url":"https://github.com/calne-ca/beets-plugin-restapi","last_synced_at":"2025-11-22T09:02:13.246Z","repository":{"id":57414513,"uuid":"356923451","full_name":"calne-ca/beets-plugin-restapi","owner":"calne-ca","description":"A beets plugin that provides a simple REST API","archived":false,"fork":false,"pushed_at":"2021-12-19T02:20:54.000Z","size":4,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-28T17:48:02.648Z","etag":null,"topics":["beets","beets-plugin","music","plugin","python","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/calne-ca.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}},"created_at":"2021-04-11T16:44:43.000Z","updated_at":"2022-12-01T22:37:46.000Z","dependencies_parsed_at":"2022-09-02T14:51:48.285Z","dependency_job_id":null,"html_url":"https://github.com/calne-ca/beets-plugin-restapi","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/calne-ca/beets-plugin-restapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calne-ca%2Fbeets-plugin-restapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calne-ca%2Fbeets-plugin-restapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calne-ca%2Fbeets-plugin-restapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calne-ca%2Fbeets-plugin-restapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/calne-ca","download_url":"https://codeload.github.com/calne-ca/beets-plugin-restapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/calne-ca%2Fbeets-plugin-restapi/sbom","scorecard":{"id":263167,"data":{"date":"2025-08-11","repo":{"name":"github.com/calne-ca/beets-plugin-restapi","commit":"04ff3e7b5eb0e0000a1b7470deaccb8d393c64df"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Code-Review","score":0,"reason":"Found 0/2 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-17T11:18:22.199Z","repository_id":57414513,"created_at":"2025-08-17T11:18:22.200Z","updated_at":"2025-08-17T11:18:22.200Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":285762950,"owners_count":27227464,"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","status":"online","status_checked_at":"2025-11-22T02:00:05.934Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["beets","beets-plugin","music","plugin","python","python3"],"created_at":"2024-11-11T16:10:52.980Z","updated_at":"2025-11-22T09:02:13.229Z","avatar_url":"https://github.com/calne-ca.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![PyPI version](https://badge.fury.io/py/beets-rest-api.svg)](https://badge.fury.io/py/beets-rest-api)\n\n# Beets REST API Plugin\n\nThis is a plugin for the music management tool [beets](https://beets.io).\u003cbr\u003e\nThis plugin provides a simple REST API for your music library.\u003cbr\u003e\n\nThe API is similar to the API provided by the official [beets web plugin](https://beets.readthedocs.io/en/stable/plugins/web.html).\nIn contrast to the web plugin this plugin does not provide a web interface though. With this plugin I addressed some issues in the official web plugin's api that made it unusable for me.\n\n## API\n\nThe table below shows all interfaces currently provided by the API:\n\n| Method | Path                | Description                                      | Parameters                                                                                  | Response Type            |\n|--------|---------------------|--------------------------------------------------|---------------------------------------------------------------------------------------------|--------------------------|\n| GET    | /items              | Get a list of all items matching a certain query | *query*:\u003cbr\u003eA [beets query](https://beets.readthedocs.io/en/stable/reference/query.html)    | application/json         |\n| GET    | /item/{itemId}/file | Download the audio file for an item              | -                                                                                           | application/octet-stream |\n| GET    | /item/{itemId}/art  | Download the cover art for an item.              | *size* (optional):\u003cbr\u003eIf provided returns the image\u003cbr\u003ewith a resolution of size x size     | image/jpeg               |\n\n## Setup\n\n### Install the plugin\n\n````bash\npip install beets-rest-api  \n````\n\n### Configure the plugin\nEdit your [beets configuration file](https://beets.readthedocs.io/en/stable/reference/config.html) and add the following section:\n\n````yaml\nrestapi:\n    host: 0.0.0.0   # The IP address the web server should bind to\n    port: 8338      # The port the web server should bind to\n````\n\nAlso add *restapi* to the *plugins* section.\n\n### Run the plugin\n\nYou can start the plugin by running:\n````bash\nbeet restapi\n````\n\nThis will start a web server and block the command execution.\nIf you want to run it in the background you can run it this way instead:\n\n````bash\nbeet restapi \u0026\u003e/dev/null \u0026    # Unix\n````\n\nIf the web server should always run you can add this code to a script file and add it to the autostart (Windows), crontab (Unix) or any other way of running a script on system startup.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalne-ca%2Fbeets-plugin-restapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcalne-ca%2Fbeets-plugin-restapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalne-ca%2Fbeets-plugin-restapi/lists"}