steamship.cli package#

Subpackages#

Submodules#

steamship.cli.cli module#

steamship.cli.cli.initialize(suppress_message: bool = False)[source]#
steamship.cli.cli.initialize_and_get_client_and_prep_project()[source]#
steamship.cli.cli.register_locally_running_package_with_engine(client: Steamship, ngrok_api_url: str, package_handle: str, manifest: Manifest, config: str | None = None) → PackageInstance[source]#

Registers the locally running package with the Steamship Engine.

steamship.cli.cli.serve_local(port: int = 8443, no_ngrok: bool | None = False, no_repl: bool | None = False, config: str | None = None, workspace: str | None = None)[source]#

Serve the invocable on localhost. Useful for debugging locally.

steamship.cli.create_instance module#

class steamship.cli.create_instance.LoggingDisabled[source]#

Bases: object

Context manager that turns off logging within context.

steamship.cli.create_instance.cannot_parse_config(config: str, exception: Exception | None = None)[source]#
steamship.cli.create_instance.config_str_to_dict(config: str | None = None) -> (typing.Dict[str, typing.Any], <class 'bool'>)[source]#

Convert config string into dict.

The input string can be a JSON-string or the name of a file.

steamship.cli.create_instance.load_manifest()[source]#
steamship.cli.create_instance.set_unset_params(config, invocable_config, is_file, manifest)[source]#

steamship.cli.deploy module#

class steamship.cli.deploy.DeployableDeployer[source]#

Bases: ABC

ask_for_new_handle(manifest: Manifest, was_missing: bool = False)[source]#
ask_for_new_version_handle(manifest: Manifest, was_missing: bool = False)[source]#
abstract create_object(client: Steamship, manifest: Manifest)[source]#
create_or_fetch_deployable(client: Steamship, user: User, manifest: Manifest)[source]#
create_version(client: Steamship, manifest: Manifest, thing_id: str)[source]#
abstract deployable_type()[source]#
abstract update_object(deployable, client: Steamship, manifest: Manifest)[source]#
class steamship.cli.deploy.PackageDeployer[source]#

Bases: DeployableDeployer

create_object(client: Steamship, manifest: Manifest)[source]#
deployable_type()[source]#
update_object(deployable, client: Steamship, manifest: Manifest)[source]#
class steamship.cli.deploy.PluginDeployer[source]#

Bases: DeployableDeployer

create_object(client: Steamship, manifest: Manifest)[source]#
deployable_type()[source]#
update_object(deployable, client: Steamship, manifest: Manifest)[source]#
steamship.cli.deploy.bundle_deployable(manifest: Manifest)[source]#
steamship.cli.deploy.get_archive_path(manifest: Manifest) → Path[source]#
steamship.cli.deploy.update_config_template(manifest: Manifest)[source]#

steamship.cli.login module#

steamship.cli.login.login(api_base: str, web_base: str) → str[source]#

steamship.cli.manifest_init_wizard module#

steamship.cli.manifest_init_wizard.manifest_init_wizard(client: Steamship)[source]#
steamship.cli.manifest_init_wizard.validate_handle(handle: str) → str[source]#
steamship.cli.manifest_init_wizard.validate_version_handle(handle: str) → str[source]#

steamship.cli.requirements_init_wizard module#

steamship.cli.requirements_init_wizard.requirements_init_wizard()[source]#

steamship.cli.ship_spinner module#

class steamship.cli.ship_spinner.Spinner[source]#

Bases: object

init_spin()[source]#
spinner_cycle = <itertools.cycle object>#
start()[source]#
stop()[source]#
steamship.cli.ship_spinner.ship_spinner()[source]#

This function creates a context manager that is used to display a spinner on stdout as long as the context has not exited. The spinner is created only if stdout is not redirected, or if the spinner is forced using the force parameter.

steamship.cli.utils module#

Common utilities for the Steamship Python API

steamship.cli.utils.find_api_py() → Path[source]#
steamship.cli.utils.get_api_module(path: Path)[source]#
steamship.cli.utils.is_in_replit() → bool[source]#

Returns True if the user appears to be inside Replit.

Module contents#