CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning with one exception: minor yet potentially breaking changes to the data model that are made to maintain compatibility with the Beaker server and not necessarily given new major releases. We often use patch releases for compatibility fixes instead.

Unreleased

v1.38.1 - 2025-10-14

Added

• Added missing optional budget for Image data model.
• Added missing optional budget for Dataset data model.

v1.38.0 - 2025-10-10

Added

• Added optional budget parameter to Beaker.dataset.create() method for specifying budget during dataset creation.
• Added optional budget parameter to Beaker.image.create() method for specifying budget during image creation.

v1.37.0 - 2025-09-15

Added

• Added missing budget field for Experiment data model.

Changed

• budget argument to ExperimentSpec is now optional.

v1.36.4 - 2025-07-16

Added

• Added new aliases field to Cluster data model.

v1.36.3 - 2025-07-11

Added

• Added immediate priority.

v1.36.2 - 2025-04-24

Added

• Added strict option to Beaker.experiment.latest_job() method.
• Added Beaker.experiment.all_latest_jobs() methods.
• Added owner_org, budget_id, slot_limit_preemptible, slot_limit_non_preemptible, and assigned_slots_preemptible fields to Workspace.

v1.36.1 - 2025-04-23

Fixed

• Fixed a bug where some remaining logs lines might not get downloaded from Beaker.job.follow_structured().

v1.36.0 - 2025-04-23

Added

• Added Beaker.(job|experiment).follow_structured() and Beaker.(job|experiment).structured_logs() methods, which stream structured log events using the RPC interface.

v1.35.0 - 2025-04-21

Added

• Added Beaker.job.summarized_events() method.

v1.34.3 - 2025-04-15

Fixed

• Fixed bug introduced in last release where a timeout (or synchronized_start_timeout) of None in an experiment spec would cause a validation error.

v1.34.2 - 2025-04-14

Fixed

• Allow setting timeout fields as duration strings when loading an experiment spec from YAML or JSON.

v1.34.1 - 2025-02-25

Fixed

• Fixed how we send task timeout to server.

v1.34.0 - 2025-02-25

Added

• Added Beaker.experiment.set_description() method.

v1.33.0 - 2025-02-25

Added

• Added timeout field to TaskSpec.

v1.32.3 - 2024-12-11

Added

• Added new field Cluster.max_session_timeout: Optional[int].
• Added new field JobExecution.retry_ancestor: Optional[str].

Fixed

• Made checking for version upgrades more robust.

v1.32.2 - 2024-11-13

Fixed

• Relaxed requirements on Docker layer upload/download status strings.

v1.32.1 - 2024-11-01

Added

• Added new WorkspaceSize.environments field.

v1.32.0 - 2024-10-07

Added

• Added retry field to ExperimentSpec.

v1.31.3 - 2024-08-30

Added

• Increased Beaker.from_env() default timeout from 5s to 30s

v1.31.2 - 2024-07-26

Added

• Added node_has_gpus field to Job.

v1.31.1 - 2024-07-14

Fixed

• Fixed Task.replica_rank to be set to the right value now instead of always None.

v1.31.0 - 2024-07-08

Added

• Added execution_results to Job model.

v1.30.0 - 2024-06-14

Added

• Added weka option to DataSource model.

Fixed

• Only check for upgrades once every 12 hours by default.

v1.29.1 - 2024-06-13

Fixed

• Raise ExperimentConflict when stopping an experiment that was already stopped from Beaker.experiment.stop.

v1.29.0 - 2024-06-13

Added

• Added author filter to Beaker.job.list().
• Added Beaker.experiment.list() method.

v1.28.0 - 2024-06-13

Added

• Added Job.is_preemptible property.
• Added Job.is_running property.
• Added Job.is_queued property.
• Added ClusterUtilization.jobs field.

v1.27.2 - 2024-05-31

Added

• Added since argument to Beaker.experiment.follow().

Fixed

• Fixed an issue with using timedelta objects for the since argument with Beaker.(experiment|job).(follow|logs).

v1.27.1 - 2024-05-31

Added

• Added TaskSpec.propagate_preemption field.

v1.27.0 - 2024-05-31

Added

• Added since argument to Beaker.job.follow.

v1.26.15 - 2024-05-30

Fixed

• Fixed another bug with identifying preemptible jobs in Beaker.cluster.utilization.

v1.26.14 - 2024-05-29

Added

• Added Experiment.canceled and Experiment.canceled_for fields.

Fixed

• Fixed detection of preemptible jobs in Beaker.cluster.utilization().

v1.26.13 - 2024-05-28

Added

• Added Secret.author_id field.
• Added Cluster.require_preemptible_tasks field.

Fixed

• Updated dependencies list to work-around docker-py#3256.

v1.26.12 - 2024-05-10

Added

• Added preemptible argument to TaskSpec.new().
• Added Workspace.max_workload_priority field.
• Added Job.preemptible field.

v1.26.11 - 2024-05-10

Added

• Added new field TaskContext.preemptible.

v1.26.10 - 2024-05-02

Added

• Added support for passing human-readable synchronized_start_timeout duration strings to TaskSpec.new(), like "10sec", "1m", etc.

v1.26.9 - 2024-05-02

Fixed

• Update synchronized_start_timeout to send nanoseconds to the Beaker server instead of a string.

v1.26.8 - 2024-05-01

• Added new fields JobStatus.ready, JobExecution.replica_rank, and JobExecution.replica_group_id.

v1.26.7 - 2024-04-30

Added

• Added synchronized_start_timeout field to TaskSpec.

v1.26.6 - 2024-04-24

Added

• Added propagate_failure field to TaskSpec.

v1.26.5 - 2024-04-18

Fixed

• Numbers are now allowed in command and arguments fields for experiment specs.

v1.26.4 - 2024-04-10

Fixed

• Relaxed CanceledCode schema to accept arbitrary integers.

v1.26.3 - 2024-03-20

Fixed

• Fixed logic in Beaker.cluster.utilization() to check job.limits instead of job.requests for the source of truth.

v1.26.2 - 2024-02-29

Added

• Added ignore_failures option to Beaker.cluster.preempt_jobs().

v1.26.1 - 2024-02-28

Fixed

• Made public argument optional for Beaker.workspace.create().

v1.26.0 - 2024-02-28

Added

• Added cluster method Beaker.cluster.preempt_jobs().
• Added argument allow_preemptible to Beaker.cluster.update().

v1.25.1 - 2024-02-26

Fixed

• Added missing field Cluster.max_job_timeout.

v1.25.0 - 2024-02-22

Changed

• budget is now a required field for experiment specs.

v1.24.0 - 2024-01-30

Added

• Added budget field to experiment spec.

v1.23.0 - 2023-12-15

Fixed

• Allow only key-word arguments with Beaker.experiment.create().

v1.22.0 - 2023-09-25

Changed

• Allow experiment name to be None when creating new experiments via Beaker.experiment.create().

v1.21.0 - 2023-09-08

Added

• Added .priority convenience property to Job data model class.
• Added Beaker.job.url() method to get the URL for a job.

Fixed

• Fixed a bug with Beaker.cluster.utilization() that resulted in inflated numbers for the amount of running jobs.

v1.20.1 - 2023-09-01

Fixed

• Added new missing cancellation code (4 = manual cancellation) to enumeration.

v1.20.0 - 2023-07-28

Added

• Added prefix parameter to Beaker.dataset.fetch().

v1.19.0 - 2023-07-17

Added

• Added support for Pydantic V2.
• Added missing field compute_source on Cluster data model.

v1.18.8 - 2023-07-12

Fixed

• Made WorkspacePermissions.authorizations field optional (users without the right permissions level won't see this field).

v1.18.7 - 2023-06-19

Added

• Added hostname constraint.

v1.18.6 - 2023-06-02

Fixed

• Fixed data validation for DataSource.

v1.18.5 - 2023-05-25

Added

• Added missing field Cluster.allow_preemptible_restriction_exceptions.

v1.18.4 - 2023-04-27

Fixed

• Added support for uploading empty files to datasets.

v1.18.3 - 2023-04-19

Added

• Added missing fields total_size and num_files to DatasetStorage.

v1.18.2 - 2023-03-22

Fixed

• Fixed TaskSpec.constraints to behave like a dictionary for backwards compatibility.

v1.18.1 - 2023-03-14

Added

• Added missing field docker_tag to Image.

v1.18.0 - 2023-03-07

Added

• Added missing host_networking, replicas, and leader_selection fields to TaskSpec.

Removed

• Removed the multiprocessing argument to Beaker.dataset.fetch(). After the bug that was fixed in v1.17.6 it's no-longer worth using a ProcessPoolExecutor (in fact it's much slower than the ThreadPoolExecutor).

v1.17.7 - 2023-02-20

Fixed

• Fixed bug with dataset download progress bar jumping around.

v1.17.6 - 2023-02-20

Fixed

• Fixed bug causing slow dataset downloads.

v1.17.5 - 2023-02-17

Added

• Added new field Job.result, Job.execution.result is deprecated.
• Added new field Task.replica_rank.

v1.17.4 - 2023-02-17

Fixed

• Fixed latest tag (was "LATEST", should have been "latest")

v1.17.3 - 2023-02-17

Added

• Added a latest tagged Docker image.

v1.17.2 - 2023-02-15

Fixed

• Catch case where user token is empty, raise ConfigurationError.

v1.17.1 - 2023-02-14

Added

• Added multiprocessing option to Beaker.dataset.fetch(). This can speed things up substantially for datasets with a lot of files.

v1.17.0 - 2023-02-13

Added

• Added ExperimentSpec.new() constructor.

Changed

• The cluster argument to TaskSpec.new() and ExperimentSpec.new() can now be given as a list of clusters which is equivalent to adding a "cluster" list in the constraints field.

Fixed

• Beaker.workspace.clear() will remove uncommitted datasets too.
• Fixed the progress bar total in Beaker.dataset.fetch() and improved handling of KeyboardInterrupt.

v1.16.0 - 2023-01-26

Added

• Added missing user_restrictions field to Cluster data model.
• Added Beaker.job.preempt() method.
• Added Job.was_preempted property.
• Added job attribute to JobFailedError and task attribute to TaskStoppedError.
• Added DEBUG logging statements for every request and response to/from the Beaker server. To see these, just enable logging at the DEBUG level (though you may want to disable DEBUG logging from the "urllib3" logger, as that will create a lot of noise). For example:

  import logging
  
  logging.basicConfig(level=logging.DEBUG)
  logging.getLogger("urllib3").setLevel(logging.INFO)

Fixed

• Fixed bug where Beaker.experiment.wait_for() would fail if a job was preempted.

v1.15.0 - 2023-01-19

Added

• Added DigestHashAlgorithm enum to represent Digest.algorithm.
• Added Digest.new_hasher() method.
• Added fields Job.host_networking, Job.port_mappings, and Session.ports_v2.

Fixed

• For backwards compatibility, Digest can now be instantiated again from a string, e.g. Digest("SHA256 iA02Sx8UNLYvMi49fDwdGjyy5ssU+ttuN1L4L3/JvZA=").

v1.14.1 - 2023-01-18

Fixed

• No more blank lines printed when passing quiet=True to methods.

v1.14.0 - 2023-01-17

Added

• Added prefix parameter to Beaker.dataset.ls().

Fixed

• The FileInfo objects from Beaker.dataset.ls() will now include the digest.

v1.13.2 - 2023-01-03

Changed

• Beaker.dataset.ls() now returns a list instead of a generator.

Fixed

• Fixed Beaker.dataset.ls(), .get_file(), .stream_file(), .fetch(), .size() methods.

v1.13.1 - 2022-12-21

Added

• Added missing urlv2 field to DatasetStorage data model.
• Added missing constraints field to Session data model.
• Added missing description field to Group data model.

Removed

• Removed deprecated url field from FileInfo data model.

v1.13.0 - 2022-12-09

Added

• Added cursor, sort_by and ordering options to Beaker.workspace.* search methods.

v1.12.1 - 2022-12-08

Fixed

• Improved Beaker.(dataset|experiment|image).get() when looking up objects in the default workspace that were created by other users.

v1.12.0 - 2022-11-23

Added

• Added Beaker.workspace.iter_(images|experiments|datasets) methods.
• Added older_than parameter to Beaker.workspace.clear() method.

Fixed

• Fixed Beaker.experiment.results() when dataset no longer exists. It will now return None instead of failing with DatasetNotFound.

v1.11.6 - 2022-11-22

Added

• Added missing url field to DatasetStorage.

Removed

• Removed old field fileheap from DatasetSpec.

v1.11.5 - 2022-11-16

Added

• Added missing size field to Image data model

v1.11.4 - 2022-11-07

Changed

• TaskSpec.with_contraint now takes **kwargs instead of two positional arguments.

v1.11.3 - 2022-10-28

Added

• Added customizable user_agent attribute to Beaker client.

Fixed

• Added missing account_id field to Node data model.
• Added missing identity field to Session data model.

v1.11.2 - 2022-10-07

Added

• Added missing constraints field to TaskSpec data model.

v1.11.1 - 2022-10-07

Fixed

• Added missing cluster_id field to Node data model.

v1.11.0 - 2022-10-06

Changed

• The cluster field in Job and TaskContext is now optional.

v1.10.3 - 2022-09-28

Fixed

• Fixed data validation for job/task Priority. "urgent" now allowed.

v1.10.2 - 2022-09-27

Fixed

• Fixed mispelled field sharedMemory -> shared_memory in JobRequests data model.

v1.10.1 - 2022-09-23

Added

• Added missing fields cordoned, cordon_reason, cordon_agent_id to data model for Node.

Fixed

• Made expiry field optional for Node data model.
• Beaker.cluster.filter_available() will ignore cordoned nodes.

v1.10.0 - 2022-09-21

Added

• Added Beaker.dataset.upload() for uploading raw bytes to a file in a dataset.

v1.9.2 - 2022-09-21

Added

• Added Beaker.workspace.clear() method for removing all items from a workspace.

Fixed

• Made Beaker.dataset.commit() more robust by allowing automatic retries for recoverable errors.

v1.9.1 - 2022-09-15

Changed

• beaker-py will issue warnings now when unknown fields are encountered.

v1.9.0 - 2022-09-14

Added

• Added pool_maxsize argument to Beaker client.
• Added canceled_for and canceled_code fields to Job.status.

Fixed

• Beaker.experiment.(wait_for|as_completed) won't fail when a job is preempted.

v1.8.1 - 2022-09-09

Changed

• Added better debug logging when recoverable errors happen.

Fixed

• Made Beaker.dataset.fetch() more robust to corrupted downloads.

v1.8.0 - 2022-09-08

Added

• Added Beaker.dataset.get_file(). Similar to stream_file(), but returns the entire bytes at once and is more robust since it will retry internally when HTTP and timeout errors occur.

Fixed

• Made most methods more robust to all recoverable errors that can occur while contacting the Beaker server, such HTTP, timeout, connection, and SSL errors.

v1.7.4 - 2022-09-07

Fixed

• 500 errors from server treated as recoverable.

v1.7.3 - 2022-09-06

Fixed

• 429 errors treated as recoverable.
• Fixed an error with Beaker.experiment.(wait_for|as_completed|follow) that would hang if an experiment's task was stopped before a job was created.

v1.7.2 - 2022-09-06

Fixed

• Fixes an issue where a job that was canceled during initialization or provisioning might not get marked as a failure.

v1.7.1 - 2022-08-31

Fixed

• Fixed bug with Beaker.(job|experiment).follow() where final line wasn't returned.

Removed

• Removed deprecated url option for DataMount.

v1.7.0 - 2022-08-30

Added

• Added argument include_timestamps: bool to Beaker.(job|experiment).follow().

Fixed

• Fixed returning duplicate log lines from Beaker.(job|experiment).follow().

v1.6.9 - 2022-08-01

Fixed

• Fixed a bug in Beaker.group.create() where the description argument would be ignored.

v1.6.8 - 2022-07-27

Changed

• Shortened URLs for dataset and image.

v1.6.7 - 2022-07-20

Fixed

• Fixed a bug in Beaker.(job|experiment).follow() where some final log lines might not be yielded before the method returns.

v1.6.6 - 2022-07-19

Fixed

• Fixed bug where Beaker.experiment.delete() would fail if the result dataset was already deleted.

v1.6.5 - 2022-07-15

Fixed

• Fixed bug with checking job status. Sometimes a successful job would be marked as failed.

v1.6.4 - 2022-07-14

Fixed

• Removed outdated field owner from Experiment, Task, and Dataset.

v1.6.3 - 2022-07-05

Fixed

• Handling empty string values in Beaker config YAML files for compatibility with beaker CLI. Any empty string values in a Beaker config YAML file are now converted to None when the Config object is loaded from the file. On the other hand, if you try to explicitly set the value of a field to an empty string when initializing the Beaker client (e.g. Beaker.from_env(default_org='')) you'll get a ValueError.

v1.6.2 - 2022-06-27

Fixed

• Fixed a bug where the session parameter to Beaker.from_env() wasn't actually passed through to the class' __init__() method.

v1.6.1 - 2022-06-24

Changed

• Added support for older versions of Pydantic (back to v1.8.2).

v1.6.0 - 2022-06-17

Added

• Added Beaker.job.follow() and Beaker.experiment.follow() methods for live streaming logs.

Changed

• The return type of Beaker.experiment.tasks() behaves like both a Sequence[Task] and a Mapping[str, Task], i.e. you can call __getitem__() with either an int, slice, or a str for the name of a task.

Fixed

• Fixed a bug where Beaker.(job|experiment).(wait_for|as_completed)() methods could hang if a job was canceled or failed to ever start for some reason.

v1.5.1 - 2022-06-16

Changed

• Beaker.(job|experiment).(wait_for|as_completed)() methods now raises a more specific JobTimeoutError (which inherits from TimeoutError) instead of a generic TimeoutError.

v1.5.0 - 2022-06-16

Added

• Added since parameter to Beaker.job.logs() and Beaker.experiment.logs().

v1.4.2 - 2022-06-13

Fixed

• Fixed bug in loading config where encountering unknown fields would cause an exception. beaker-py now gracefully handles this.

v1.4.1 - 2022-06-10

Added

• Added session argument to Beaker client constructors (.from_env() and __init__()). You can use this argument to force the client to use a single HTTP Session for all requests to the server for the life of the client. Using this approach it's not necessary to use the Beaker.session() context manager, but you should only use this if the client is short-lived.

v1.4.0 - 2022-06-09

Added

• Added Beaker.session() context manager for improving performance when calling a series of client methods in a row.
• Added timeout parameter to Beaker client initialization methods with a default of 5 (seconds). This controls the connect and read timeouts of HTTP requests sent to the Beaker server.

v1.3.0 - 2022-05-31

Added

• Added Beaker.group.export_experiments() method.

Fixed

• Fixed Job priority validation.

v1.2.0 - 2022-05-25

Added

• Added Beaker.dataset.file_info() method.
• Added .workspace (WorkspaceRef) property to Dataset, Image, Group, and Experiment. This is just an alias for the .workspace_ref property.

Changed

• Beaker.dataset.stream_file() now can also take a FileInfo object as the 2nd argument instead of a file path.
• Digest class is now hashable.

v1.1.0 - 2022-05-18

Added

• Added ExperimentSpec.to_file() method.

v1.0.0 - 2022-05-13

Removed

• Removed deprecated Beaker.experiment.await_all() method.

v0.15.3 - 2022-05-10

Added

• Added Digest type and changed type of FileInfo.digest from str to Digest.

v0.15.2 - 2022-05-09

Added

• Added Beaker.experiment.latest_job() method.
• Added strict: bool argument to Beaker.(experiment|job).(wait_for|as_completed) methods.
• Added description and source_execution fields to Dataset.
• Added description field to Experiment.
• Added description field to Image.
• Added description field to Workspace.

v0.15.1 - 2022-05-06

Added

• Docker images released with major and major+minor version tags in addition to full version tag.

v0.15.0 - 2022-05-06

Added

• Added ExperimentSpec.with_description().
• Added TaskSpec.with_image(), .with_result(), .with_context(), .with_name(), .with_command(), and .with_arguments().

Changed

• Renamed delete_results_dataset param to delete_results_datasets in Beaker.experiment.delete().
• Renamed TaskSpec.with_data() to TaskSpec.with_dataset().

Fixed

• Fixed bug with Beaker.experiment.delete() that would lead to a ValueError being raised when the experiment to delete has multiple tasks.

v0.14.1 - 2022-05-05

Changed

• Replaced id: str field of ClusterUtilization with cluster: Cluster. id is still available as a property for backwards compatibility.

v0.14.0 - 2022-05-04

Added

• Added description parameter to Beaker.dataset.create(), Beaker.image.create(), Beaker.workspace.create().
• Added public parameter to Beaker.workspace.create().

Changed

• Beaker.workspace.grant_permissions now takes a Permission enum type instead of a raw string, but raw strings will still work.

v0.13.2 - 2022-04-29

Changed

• The Beaker.account.name property is now cached for performance reasons with a TTL cache.
• Renamed Cluster.nodeCost to Cluster.node_cost for consistency.
• Fixed some issues around mutable data models with properties that have different snake case vs lower camel case names.

v0.13.1 - 2022-04-28

Changed

• Beaker.dataset.fetch() and Beaker.dataset.stream_file() now verify the digest of the downloaded bytes against the expected digest by default. A ChecksumFailedError is raised if they don't match. You can skip validating the checksum by passing validate_checksum=False.
• Added a progress bar to Beaker.dataset.stream_file(). This can be disabled by passing quiet=True.

v0.13.0 - 2022-04-27

Added

• Added Beaker.dataset.url() method.
• Added Beaker.image.url() method.
• Added Beaker.group.url() method.
• Added Beaker.workspace.url() method.
• Added Beaker.cluster.url() method.

Changed

• Improved performance of Beaker.cluster.filter_available() by using a ThreadPoolExecutor for concurrency.
• Changed behavior of Beaker.dataset.create() and Beaker.dataset.sync() with respect to source files. By default now, source files and directories will be uploading as their given path, instead of just their name. You can still get the old behavior by passing strip_paths=True.
• Changed default value of max_workers to None in Beaker.dataset.create() and .sync(). When left as None, the number of workers will be determined by the ThreadPoolExecutor.
• "." now allowed in beaker names.

v0.12.0 - 2022-04-26

Added

• Added FAQ section to the docs.
• All data models are now hashable and faux immutable, and use tuples instead of lists.
• Added delete_results_dataset: bool = True parameter to Beaker.experiment.delete().
• Added Cluster.is_cloud and Cluster.is_active properties.

Changed

• Changed the return type of Beaker.cluster.filter_available() from List[Cluster] to List[ClusterUtilization].
• Renamed and consolidated NodeSpec and NodeShape to NodeResources.

v0.11.0 - 2022-04-21

Added

• Added Task.latest_job property.

Changed

• Changed signature of Beaker.experiment.(logs|metrics|results) methods: replaced parameter task_name: Optional[str] with task: Optional[Union[str, Task]].

v0.10.0 - 2022-04-20

Added

• Added Beaker.image.rename() method.
• Added Beaker.image.pull() method.
• Added Beaker.experiment.url() method.

Changed

• Changed return type of Beaker.cluster.utilization() to ClusterUtilization.

v0.9.0 - 2022-04-19

Added

• Added Beaker.group client and methods.
• Added Beaker.workspace.groups() method.
• Added Beaker.experiment.resume() method.
• Added Beaker.experiment.metrics() method.
• Added Beaker.job.metrics() method.
• Added Beaker.job.results() method.
• Added Beaker.job.wait_for() method.
• Added Beaker.job.as_completed() method.
• Added Beaker.experiment.as_completed() method.
• Added Beaker.image.commit() method.
• Added commit parameter to Beaker.image.create().

Changed

• Changed the signature of Beaker.experiment.results(). Added the task_name parameter and changed the return type to Optional[Dataset].
• Changed the signature of Beaker.experiment.logs(). Removed the job_id parameter and added the task_name parameter.
• Deprecated Beaker.experiment.await_all(). Use Beaker.experiment.wait_for() instead.

Fixed

• Fixed bug with Beaker.image.create().

v0.8.4 - 2022-04-18

Fixed

• Fixed issue in data model for Experiment. name and full_name are now optional.
• Fixed issue in data model for Image. name and full_name are now optional.

v0.8.3 - 2022-04-14

Added

• Added Beaker.workspace.(get|set|grant|revoke)_permissions() and .set_visibility() methods.

Changed

• Added better support for referencing Beaker items (images, experiments, datasets, etc) by their short name (without workspace, org, or account prefix) when the full name or ID can be assumed.
• Improved error documentation.

v0.8.2 - 2022-04-13

Added

• Implemented Beaker.workspace.archive(), .unarchive(), .rename(), .move(), and create() methods.
• Implemented Beaker.job.stop() and Beaker.job.finalize() methods.
• Added WorkspaceWriteError for when you attempt to write to an archived workspace. Before this would just result in an HTTPError with a 403 status code.

Changed

• Allowed using workspace name without organization when Config.default_org is set. Otherwise OrganizationNotSet error is raised.

v0.8.1 - 2022-04-12

Added

• Implemented __str__ method on Beaker client for debugging.
• Improved documentation for ExperimentSpec, TaskSpec, and other related data models, and added new convenience constructors such as TaskSpec.new().

Changed

• Changed default spec version to v2.

Fixed

• Improved experiment spec validation in Beaker.experiment.create() to raise more specific error types.

v0.8.0 - 2022-04-12

Changed

• Beaker.experiment.await_all() now takes a variable number of experiments and returns a list with the same length and order of the finished experiments.

Fixed

• Fixed bug where Beaker.experiment.create() would fail with an HTTPError if the image in the spec doesn't exist. Now this will fail with ImageNotFound.

v0.7.0 - 2022-04-11

Changed

• Made org parameter optional, defaulting to Config.default_org.

Fixed

• Fixed the behavior of some methods that take a workspace parameter. Previously, if the workspace didn't exist, it would be silently created. Now a WorkspaceNotFound error is raised.

v0.6.1 - 2022-04-11

Added

• Added Beaker.workspace.secrets().
• Added Beaker.secret.get().
• Added Beaker.secret.read().
• Added Beaker.secret.write().
• Added Beaker.secret.delete().

v0.6.0 - 2022-04-11

Added

• Added Beaker.experiment.rename().
• Added Beaker.experiment.tasks().
• Added Beaker.experiment.results().
• Added Beaker.experiment.spec().
• Added Beaker.workspace.datasets().
• Added Beaker.workspace.experiments().
• Added Beaker.workspace.images().
• Added Beaker.workspace.list().
• Added Beaker.account.get().

Removed

• Removed Beaker.experiment.list(). Please use Beaker.workspace.experiments() instead.

v0.5.5 - 2022-04-10

Added

• Added callback parameter to Beaker.experiment.await_all().

v0.5.4 - 2022-04-10

Added

• Added Beaker.dataset.size().
• Added Beaker.dataset.rename().
• Added ExperimentSpec.from_file().
• Added Beaker.cluster.filter_available().

v0.5.3 - 2022-04-08

Added

• Added Beaker.dataset.commit().
• Added Beaker.dataset.ls().
• Added Beaker.dataset.stream_file().

Changed

• Changed behavior of target parameter in Beaker.dataset.create(). It now always represents the name of a directory.
• Changed the signature of Beaker.dataset.create(). It now accepts a variable number of source files or directories.

v0.5.2 - 2022-04-07

Added

• Added Beaker.experiment.stop().

Fixed

• Fixed bug with Beaker.experiment.await_all().

v0.5.1 - 2022-04-07

Fixed

• Fixed bug with Beaker.jobs.list().

v0.5.0 - 2022-04-07

Added

• Added Beaker.node service client.
• Added Beaker.job.get() and Beaker.job.list() methods.
• Added Beaker.cluster.utilization().

Fixed

• Fixed warning about newer version.

Removed

• Removed Execution data model, since it's deprecated and redundant with Job.

v0.4.3 - 2022-04-06

Added

• Added Beaker.account.name property and Beaker.account.list_organizations() method.
• Added ExperimentSpec and all components to the data model.
• Added Beaker.cluster service client for managing Beaker clusters.
• Added Beaker.organization service client for managing Beaker organizations.

Changed

• Beaker.experiment.create() now accepts either an ExperimentSpec instance or the path to a YAML spec file.

v0.4.2 - 2022-04-04

Added

• Added support for large files with Beaker.dataset.create().
• Added Beaker.dataset.fetch().

v0.4.1 - 2022-04-03

Added

• Added Beaker.experiment.delete() and Beaker.experiment.await_all() methods.
• Beaker.dataset.create can now handle directories.

v0.4.0 - 2022-04-03

Changed

• Breaking changs to Beaker client API. Methods for services have been split up into seperate service clients. For example, previously you would create an image with beaker.create_image(), whereas now you would do beaker.image.create().

v0.3.9 - 2022-04-01

Fixed

• Fixed bug in delete_image() that would result in ImageNotFound error when using image full name instead of ID.

v0.3.8 - 2022-04-01

Changed

• All Beaker client methods now return strongly typed data models.
• Replaced old progress diplays with prettier diplays from rich.

v0.2.8 - 2022-03-31

Fixed

• Fixed getting experiment from name.

v0.2.7 - 2022-03-31

Added

• Added Beaker.create_dataset() method.

v0.2.6 - 2022-01-19

Added

• Added list_experiments() method.

v0.2.5 - 2021-12-14

Fixed

• Fixed bug where Beaker.from_env() would fail with missing BEAKER_TOKEN even if you passed the token to the method.

v0.2.4 - 2021-12-09

Changed

• Docker Client is initialized lazily so that some functionality of Beaker client can be used on systems without Docker.

v0.2.3 - 2021-12-09

Fixed

• Fixed crash that could occur when $HOME directory doesn't exist.

v0.2.2 - 2021-12-08

v0.2.1 - 2021-12-08

Fixed

• Fixed bug with Config.save().
• Fixed bug with create_image() where it would fail if workspace doesn't exist yet.

v0.2.0 - 2021-12-07

Added

• Added many new methods.
• Added beaker.exceptions module.

Changed

• Several breaking changes to Beaker method names.

v0.1.0 - 2021-11-19

Added

• Added Beaker client class.