{"id":31908793,"url":"https://github.com/allenai/beaker-py","last_synced_at":"2025-10-13T15:56:31.270Z","repository":{"id":37057030,"uuid":"424737912","full_name":"allenai/beaker-py","owner":"allenai","description":"A pure-Python Beaker client","archived":false,"fork":false,"pushed_at":"2025-09-15T18:51:37.000Z","size":932,"stargazers_count":17,"open_issues_count":6,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-09-15T20:30:20.100Z","etag":null,"topics":["api-client","beaker","python"],"latest_commit_sha":null,"homepage":"","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/allenai.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-11-04T20:56:28.000Z","updated_at":"2025-09-15T18:51:40.000Z","dependencies_parsed_at":"2024-03-20T23:43:22.462Z","dependency_job_id":"ee1d12ac-4fcf-41d4-8671-09c447630346","html_url":"https://github.com/allenai/beaker-py","commit_stats":{"total_commits":399,"total_committers":7,"mean_commits":57.0,"dds":0.08270676691729328,"last_synced_commit":"191120b200ef838f528c31594115b6d7b63266b1"},"previous_names":[],"tags_count":161,"template":false,"template_full_name":"allenai/python-package-template","purl":"pkg:github/allenai/beaker-py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenai%2Fbeaker-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenai%2Fbeaker-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenai%2Fbeaker-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenai%2Fbeaker-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allenai","download_url":"https://codeload.github.com/allenai/beaker-py/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allenai%2Fbeaker-py/sbom","scorecard":{"id":185265,"data":{"date":"2025-08-11","repo":{"name":"github.com/allenai/beaker-py","commit":"1be16ac490f46b7c7aaf63ca7a7dfbdb745cad25"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.4,"checks":[{"name":"Maintained","score":5,"reason":"7 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":1,"reason":"Found 3/30 approved changesets -- score normalized to 1","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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/main.yml:1","Warn: no topLevel permission defined: .github/workflows/pr_checks.yml:1","Info: no jobLevel write permissions found"],"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":"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: 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":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.36.4 not signed: https://api.github.com/repos/allenai/beaker-py/releases/232993069","Warn: release artifact v1.36.3 not signed: https://api.github.com/repos/allenai/beaker-py/releases/231841261","Warn: release artifact v1.36.2 not signed: https://api.github.com/repos/allenai/beaker-py/releases/214654206","Warn: release artifact v1.36.1 not signed: https://api.github.com/repos/allenai/beaker-py/releases/214363120","Warn: release artifact v1.36.0 not signed: https://api.github.com/repos/allenai/beaker-py/releases/214339278","Warn: release artifact v1.36.4 does not have provenance: https://api.github.com/repos/allenai/beaker-py/releases/232993069","Warn: release artifact v1.36.3 does not have provenance: https://api.github.com/repos/allenai/beaker-py/releases/231841261","Warn: release artifact v1.36.2 does not have provenance: https://api.github.com/repos/allenai/beaker-py/releases/214654206","Warn: release artifact v1.36.1 does not have provenance: https://api.github.com/repos/allenai/beaker-py/releases/214363120","Warn: release artifact v1.36.0 does not have provenance: https://api.github.com/repos/allenai/beaker-py/releases/214339278"],"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":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:158: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:185: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:203: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:244: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:251: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:266: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:280: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr_checks.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/allenai/beaker-py/pr_checks.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating python:3.10-alpine to python:3.10-alpine@sha256:f00e977f6932588d3814f932df0e5b512c3d335744464ca2db67b54883496703","Warn: containerImage not pinned by hash: examples/sweep/Dockerfile:4: pin your Docker image by updating python:3.9 to python:3.9@sha256:754dbbaf5fe730bb2460efb3300293c62c222f74fbf8534ed23691c617c9609b","Warn: containerImage not pinned by hash: test_fixtures/docker/Dockerfile:4: pin your Docker image by updating python:3.9-alpine to python:3.9-alpine@sha256:372f3cfc1738ed91b64c7d36a7a02d5c3468ec1f60c906872c3fd346dda8cbbb","Warn: pipCommand not pinned by hash: Dockerfile:6","Warn: pipCommand not pinned by hash: Dockerfile:7","Warn: pipCommand not pinned by hash: test_fixtures/docker/Dockerfile:11","Warn: pipCommand not pinned by hash: test_fixtures/docker/Dockerfile:12","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:257","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:258","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   3 containerImage dependencies pinned","Info:   0 out of   6 pipCommand dependencies pinned"],"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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/main.yml:197"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 11 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T19:41:58.508Z","repository_id":37057030,"created_at":"2025-08-16T19:41:58.508Z","updated_at":"2025-08-16T19:41:58.508Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279015939,"owners_count":26085777,"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-10-13T02:00:06.723Z","response_time":61,"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":["api-client","beaker","python"],"created_at":"2025-10-13T15:56:27.313Z","updated_at":"2025-10-13T15:56:31.265Z","avatar_url":"https://github.com/allenai.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cbr\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/allenai/beaker-py/main/docs/source/_static/beaker-500px-transparent.png\" width=\"200\"/\u003e\n\u003cbr\u003e\n\u003cbr\u003e\n\u003ch1\u003ebeaker-py\u003c/h1\u003e\n\u003cp\u003eA lightweight, standalone, pure Python client for \u003ca href=\"https://beaker.org\"\u003eBeaker\u003c/a\u003e\u003c/p\u003e\n\u003chr/\u003e\n\u003c/div\u003e\n\n❗ NOTICE: this project has moved! The latest version of beaker-py is now maintained in [allenai/beaker](https://github.com/allenai/beaker/tree/main/bindings/python), with documentation at [beaker-py-docs.allen.ai](https://beaker-py-docs.allen.ai/index.html). Version 1 will continue to survive here for folks that need it. We also provide a [migration guide](https://github.com/allenai/beaker/blob/main/bindings/python/MIGRATION_GUIDE.md) to make upgrading easier.\n\n\u003chr/\u003e\n\n## Features\n\n\u003c!-- start features --\u003e\n\n🪶 *Lightweight*\n\n- Minimal dependencies.\n- Only pure-Python dependencies.\n- Communicates directly with the Beaker server via HTTP requests (Beaker CLI not required).\n\n💪 *Robust*\n\n- Automatically retries failed HTTP requests with exponential backoff.\n- Runtime data validation.\n- High test coverage.\n\n📓 *Exhaustively-typed and documented*\n\n- Thorough data model for all input / output types.\n- Every expected HTTP error from the Beaker server is translated into a specific exception type.\n\n\u003c!-- end features --\u003e\n\n## Quick links\n\n- [PyPI package](https://pypi.org/project/beaker-py/)\n- [Contributing](https://github.com/allenai/beaker-py/blob/main/CONTRIBUTING.md)\n- [License](https://github.com/allenai/beaker-py/blob/main/LICENSE)\n\n*See also 👇*\n\n- [Beaker project](https://github.com/allenai/beaker)\n- [Beaker Gantry](https://github.com/allenai/beaker-gantry)\n- Beaker-relevant *GitHub Actions*\n  - [setup-beaker](https://github.com/marketplace/actions/setup-beaker)\n  - [beaker-command](https://github.com/marketplace/actions/beaker-command)\n  - [beaker-run](https://github.com/marketplace/actions/beaker-run)\n\n## Installing\n\n### Installing with `pip`\n\n**beaker-py** is available [on PyPI](https://pypi.org/project/beaker-py/). Just run\n\n```bash\npip install 'beaker-py\u003c2.0'\n```\n\n### Installing from source\n\nTo install **beaker-py** from source, first clone [the repository](https://github.com/allenai/beaker-py):\n\n```bash\ngit clone https://github.com/allenai/beaker-py.git\ncd beaker-py\n```\n\nThen run\n\n```bash\npip install -e .\n```\n\n## Quick start\n\n\u003c!-- start quickstart --\u003e\n\nIf you've already configured the [Beaker command-line client](https://github.com/allenai/beaker/), **beaker-py** will \nfind and use the existing configuration file (usually located at `$HOME/.beaker/config.yml`).\nOtherwise just set the environment variable `BEAKER_TOKEN` to your Beaker [user token](https://beaker.org/user).\n\nEither way, you should then instantiate the Beaker client with `.from_env()`:\n\n```python\nfrom beaker import Beaker\n\nbeaker = Beaker.from_env(default_workspace=\"my_org/my_workspace\")\n```\n\nThe API of **beaker-py** is meant to mirror - as closely as possible - the API of the Beaker CLI.\nFor example, when you do this with the CLI:\n\n```bash\nbeaker dataset create --name foo .\n```\n\nThe **beaker-py** equivalent would be:\n\n```python\nbeaker.dataset.create(\"foo\", \".\")\n```\n\u003c!-- end quickstart --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallenai%2Fbeaker-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallenai%2Fbeaker-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallenai%2Fbeaker-py/lists"}