qbraid_core.services.environments.EnvironmentManagerClient

class qbraid_core.services.environments.EnvironmentManagerClient(*args, **kwargs)

Client for interacting with qBraid environment services.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
approve_publish(slug)	Approve and publish an environment (Admin only).
confirm_upload(slug)	Confirm that environment tarball was successfully uploaded to GCS.
create_environment(config[, logo_light_url, ...])	Creates a new environment with the given configuration.
create_environment_group(display_name[, ...])	Create a new environment group.
create_similar_environment(env_info, target_dir)	Create a local environment with similar packages to a cloud environment.
delete_environment(slug)	Deletes the environment with the given slug.
delete_environment_group(group_slug)	Delete an environment group.
delete_share_code(slug)	Delete the share code for an environment.
deny_publish(slug[, message])	Deny a publish request (Admin only).
generate_share_code(slug)	Generate a shareable code for an environment.
get_available_environments([page, limit])	Get list of available pre-built environments for installation.
get_credits_balance()	Get the current user's credit balance for their organization.
get_environment_by_slug(slug)	Get a specific environment by its slug.
get_environment_group_by_slug(group_slug)	Get a specific environment group by its slug.
get_environment_groups([page, limit])	Get list of environment groups.
get_environment_shared_with(slug)	Get list of users and organizations the environment is shared with.
get_pending_review_environments([page, limit])	Get list of environments pending admin review (Admin only).
get_publish_status(slug)	Get the current publishing status of an environment.
install_environment_from_storage(slug, ...)	Install environment from cloud storage (S3/GCS).
redeem_share_code(code)	Redeem a share code to gain read access to an environment.
register_external_environment(path[, name, ...])	Register an external Python environment with qBraid.
remote_publish_environment([config, ...])	Triggers the remote publish of a custom environment.
request_publish(slug)	Request to publish an environment to the public catalog.
resolve_logos(provider_name)	Resolve provider name to logo URLs via the providers API.
retrieve_remote_publish_status(env_slug)	Retrieves the status of the remote publish request for the given environment slug.
revoke_environment_access(slug, target_type, ...)	Revoke environment access from a user or organization.
revoke_publish_request(slug)	Revoke/cancel a pending publish request.
running_in_lab()	Check if running in the qBraid Lab environment.
set_publish_pending(slug)	Mark an environment as under review (Admin only).
share_environment(slug, target_type, email, ...)	Share environment with a user or organization.
sync_registry()	Synchronize environment registry with filesystem.
uninstall_environment_local(identifier[, ...])	Uninstall a locally installed environment.
unregister_external_environment(identifier)	Unregister an external environment from qBraid.
update_environment(slug, **kwargs)	Update environment metadata.
update_environment_group(group_slug[, ...])	Update an existing environment group.
update_packages(slug, packages)	Update the package list for an environment.
upload_environment(identifier[, slug, ...])	Upload local environment tarball to cloud storage (GCS).
user_credits_value()	Get the current user's qBraid credits value.
wait_for_env_remote_publish(env_slug[, ...])	Monitors the remote publish status of the given environment slug by polling the remote create status field.

Attributes

envs_paths	Returns a dictionary of environment paths.
session	The QbraidSessionV1 used to make requests.