Pre-release

This release is a pre-release and may not be stable for production use.

Beaker-py

A lightweight pure-Python client for Beaker.

Installing

Installing with pip

beaker-py is available on PyPI. Just run

pip install beaker-py

Installing from source

To install beaker-py from source, first clone the repository:

git clone https://github.com/allenai/beaker.git

Then create or activate a Python virtual environment, and run:

cd beaker/bindings/python
make dev-install

Quick start

If you've already configured the Beaker command-line client, beaker-py will find and use the existing configuration file (usually located at $HOME/.beaker/config.yml) or BEAKER_TOKEN environment variable.

Then you can instantiate the Beaker client with the .from_env() class method:

from beaker import Beaker

with Beaker.from_env() as beaker:
    ...

With the Python client, you can:

  • Query Clusters with beaker.cluster.* methods, e.g. beaker.cluster.get("ai2/jupiter-cirrascale-2").
  • Manage Datasets with beaker.dataset.* methods, e.g. beaker.dataset.create(dataset_name, source_dir).
  • Submit, track, and find Experiments with beaker.experiment.*, beaker.workload.*, and beaker.job.* methods, e.g. beaker.experiment.create(spec=spec, name=name).
  • Manage Workspaces with beaker.workspace.* methods, e.g. beaker.workspace.create("ai2/new_workspace").
  • Manage Secrets with beaker.secret.* methods, e.g. beaker.secret.write(name, value).

Example workflow

Launch and follow an experiment like beaker-gantry does:

import time
from beaker import Beaker, BeakerExperimentSpec, BeakerJobPriority


with Beaker.from_env() as beaker:
    # Build experiment spec...
    spec = BeakerExperimentSpec.new(
        description="beaker-py test run",
        beaker_image="petew/hello-world",
        priority=BeakerJobPriority.low,
        preemptible=True,
    )

    # Create experiment workload...
    workload = beaker.experiment.create(spec=spec)

    # Wait for job to be created...
    while (job := beaker.workload.get_latest_job(workload)) is None:
        print("waiting for job to start...")
        time.sleep(1.0)

    # Follow logs...
    print("Job logs:")
    for job_log in beaker.job.logs(job, follow=True):
        print(job_log.message.decode())

Development

After installing from source, you can run checks and tests locally with:

make checks

Releases

At the moment releases need to be published manually by following these steps:

  1. Ensure you've authenticated with PyPI through a ~/.pypirc file and have write permissions to the beaker-py project.
  2. Ensure the target release version defined in src/beaker/version.py is correct, or change the version on the fly by adding the Make argument BEAKER_PY_VERSION=X.X.X to the command in the next step.
  3. Run make publish for a stable release or make publish-nightly for a nightly pre-release.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.7.2)

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for allennlp from gravatar.com allennlp Avatar for beaker-py from gravatar.com beaker-py Avatar for epwalsh from gravatar.com epwalsh

Credits

Author: Allen Institute for Artificial Intelligence

Requires

Python >=3.10

Provides Extra

dev

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beaker_py-2.0.1.dev20250430.tar.gz (71.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beaker_py-2.0.1.dev20250430-py3-none-any.whl (79.8 kB view details)

Uploaded Python 3

File details

Details for the file beaker_py-2.0.1.dev20250430.tar.gz.

File metadata

  • Download URL: beaker_py-2.0.1.dev20250430.tar.gz
  • Upload date:
  • Size: 71.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.13

File hashes

Hashes for beaker_py-2.0.1.dev20250430.tar.gz
Algorithm Hash digest
SHA256 02200216a7b362a127be152e7a0c2d122c2d3be124bd01f5b76dc6b5712a3a3d
MD5 218350ffe5ba938961ef217fa488edea
BLAKE2b-256 efd26a3806c5d55b19d1fba9b63bc13c237ab8080aefb74745096686d12fb324

See more details on using hashes here.

File details

Details for the file beaker_py-2.0.1.dev20250430-py3-none-any.whl.

File metadata

File hashes

Hashes for beaker_py-2.0.1.dev20250430-py3-none-any.whl
Algorithm Hash digest
SHA256 468e1ab68394e2f50131eef8c8c147a6fdc475aef1da92ca82da59ae0b7f0daa
MD5 a3c52f29f6759bb123c0760877214b46
BLAKE2b-256 19a31d9b6645f02314ec40bb4fe73ca6afcb957c661c114b40ed34d6e6f78743

See more details on using hashes here.

Release history Release notifications | RSS feed

2.7.2

2.7.1

2.7.0

2.6.0

2.5.8

2.5.7

2.5.7.dev20260402 pre-release

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.7

2.4.6

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.0

2.2.1

2.2.0

2.1.1

2.1.0

2.0.4

2.0.3

2.0.2

2.0.1

This release

2.0.1.dev20250430 pre-release

2.0.1.dev20250429 pre-release

2.0.1.dev20250428 pre-release

2.0.1.dev20250426 pre-release

2.0.1.dev20250425 pre-release

2.0.0 yanked

Reason this release was yanked:

Unintended premature release

2.0.0.dev20250425 pre-release

2.0.0.dev0 yanked

Reason this release was yanked:

Unintended premature release

1.38.1

1.38.0

1.37.0

1.36.4

1.36.3

1.36.2

1.36.1

1.36.0

1.35.0

1.34.3

1.34.2

1.34.1

1.34.0

1.33.0

1.32.3

1.32.2

1.32.1

1.32.0

1.31.3

1.31.2

1.31.1

1.31.0

1.30.0

1.29.1

1.29.0

1.28.0

1.27.2

1.27.1

1.27.0

1.26.15

1.26.14

1.26.13

1.26.12

1.26.11

1.26.10

1.26.9

1.26.8

1.26.7

1.26.6

1.26.5

1.26.4

1.26.3

1.26.2

1.26.1

1.26.0

1.25.1

1.25.0

1.24.0

1.23.0

1.22.0

1.21.0

1.20.1

1.20.0

1.19.0

1.18.8

1.18.7

1.18.6

1.18.5

1.18.4

1.18.3

1.18.2

1.18.1

1.18.0

1.17.7

1.17.6

1.17.5

1.17.4

1.17.3

1.17.2

1.17.1

1.17.0

1.16.0

1.15.0

1.14.1

1.14.0

1.13.2

1.13.1

1.13.0

1.12.1

1.12.0

1.11.6

1.11.5

1.11.4

1.11.3

1.11.2

1.11.1

1.11.0

1.10.3

1.10.2

1.10.1

1.10.0

1.9.2

1.9.1

1.9.0

1.8.1

1.8.0

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.9

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.1

1.5.0

1.4.2

1.4.1

1.4.0

1.3.0

1.2.0

1.1.0

1.0.0

0.15.3

0.15.2

0.15.1

0.15.0

0.14.1

0.14.0

0.13.2

0.13.1

0.13.0

0.12.0

0.11.0

0.10.0

0.9.0

0.8.4

0.8.3

0.8.2

0.8.1

0.8.0

0.7.0

0.6.1

0.6.0

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.3

0.4.2

0.4.1

0.4.0

0.3.9

0.3.8

0.2.8

0.2.7

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.0

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page