steamship.data.package package

Submodules

steamship.data.package.package module

class steamship.data.package.package.Package(*, client: Client = None, id: str = None, handle: str = None, userId: str = None, profile: Manifest | None = None, description: str | None = None, readme: str | None = None, isPublic: bool = False)

Bases: CamelModel

client: Client

static create(client: Client, handle: str = None, profile: Manifest = None, is_public=False, fetch_if_exists=False) → Package

delete() → Package

Delete this package. If this package is public and another user has created an instance of it, this method will throw an error and the package will not be deleted. Deleting the package will delete any versions and instances of it that you have created.

description: str | None

static get(client: Client, handle: str) → Package

handle: str

id: str

is_public: bool

classmethod parse_obj(obj: Any) → BaseModel

profile: Manifest | None

readme: str | None

update(client: Client) → Package

user_id: str

class steamship.data.package.package.PackageCreateRequest(*, id: str = None, handle: str = None, isPublic: bool = False, profile: Manifest | None = None, fetchIfExists: bool = False)

Bases: CreateRequest

is_public: bool

profile: Manifest | None

class steamship.data.package.package.PackageUpdateRequest(*, id: str | None = None, handle: str | None = None, description: str | None = None, profile: Manifest | None = None, readme: str | None = None)

Bases: UpdateRequest

description: str | None

handle: str | None

id: str | None

profile: Manifest | None

readme: str | None

steamship.data.package.package_instance module

class steamship.data.package.package_instance.CreatePackageInstanceRequest(*, id: str = None, packageId: str = None, packageHandle: str = None, packageVersionId: str = None, packageVersionHandle: str = None, handle: str = None, fetchIfExists: bool = None, config: Dict[str, Any] = None, workspaceId: str = None, localDevelopmentURL: str | None = None)

Bases: Request

config: Dict[str, Any]

fetch_if_exists: bool

handle: str

id: str

local_development_url: str | None

Special argument only intended for creating an PackageInstance bound to a local development server.

If used, the package_version_handle should be set to LOCAL_DEVELOPMENT_VERSION_HANDLE above.

package_handle: str

package_id: str

package_version_handle: str

package_version_id: str

workspace_id: str

class steamship.data.package.package_instance.ListPackageInstancesRequest(*, pageSize: int | None = None, pageToken: str | None = None, sortOrder: SortOrder | None = SortOrder.DESC, packageId: str | None = None, packageVersionId: str | None = None, includeWorkspace: bool | None = None, acrossWorkspaces: bool | None = None)

Bases: ListRequest

across_workspaces: bool | None

include_workspace: bool | None

package_id: str | None

package_version_id: str | None

class steamship.data.package.package_instance.ListPackageInstancesResponse(*, nextPageToken: str | None = None, packageInstances: List[PackageInstance])

Bases: ListResponse

package_instances: List[PackageInstance]

class steamship.data.package.package_instance.PackageInstance(*, client: Client = None, id: str = None, handle: str = None, packageId: str = None, packageHandle: str | None = None, userHandle: str = None, packageVersionId: str = None, packageVersionHandle: str | None = None, userId: str = None, invocationURL: str = None, config: Dict[str, Any] = None, workspaceId: str = None, workspaceHandle: str = None, initStatus: InvocableInitStatus | None = None, createdAt: datetime | None = None)

Bases: CamelModel

blocks_from_invoke(path: str, verb: Verb = Verb.POST, timeout_s: float | None = None, **kwargs) → List[Block]

client: Client

config: Dict[str, Any]

static create(client: Client, package_id: str = None, package_handle: str = None, package_version_id: str = None, package_version_handle: str = None, handle: str = None, fetch_if_exists: bool = None, config: Dict[str, Any] = None) → PackageInstance

static create_local_development_instance(client: Client, local_development_url: str, package_id: str = None, package_handle: str = None, handle: str = None, fetch_if_exists: bool = True, config: Dict[str, Any] = None) → PackageInstance

created_at: datetime | None

delete() → PackageInstance

full_url_for(path: str)

static get(client: Client, handle: str) → PackageInstance

handle: str

id: str

init_status: InvocableInitStatus | None

invocation_url: str

invoke(path: str, verb: Verb = Verb.POST, timeout_s: float | None = None, **kwargs)

static list(client: Client, package_id: str | None = None, package_version_id: str | None = None, include_workspace: bool | None = None, across_workspaces: bool | None = None, page_size: int | None = None, page_token: str | None = None, sort_order: SortOrder | None = SortOrder.DESC) → ListPackageInstancesResponse

load_missing_workspace_handle()

package_handle: str | None

package_id: str

package_version_handle: str | None

package_version_id: str

classmethod parse_obj(obj: Any) → BaseModel

refresh_init_status()

task_from_invoke(path: str, verb: Verb = Verb.POST, timeout_s: float | None = None, **kwargs) → Task

user_handle: str

user_id: str

wait_for_init(max_timeout_s: float = 180, retry_delay_s: float = 1)

Polls and blocks until the init has succeeded or failed (or timeout reached).

Parameters:

• max_timeout_s (int) – Max timeout in seconds. Default: 180s. After this timeout, an exception will be thrown.

• retry_delay_s (float) – Delay between status checks. Default: 1s.

workspace_handle: str

workspace_id: str

steamship.data.package.package_version module

class steamship.data.package.package_version.CreatePackageVersionRequest(*, packageId: str = None, handle: str = None, type: str = 'file', hostingHandler: str = None, configTemplate: str = None)

Bases: Request

config_template: str

handle: str

hosting_handler: str

package_id: str

type: str

class steamship.data.package.package_version.PackageVersion(*, client: Client = None, id: str = None, packageId: str = None, handle: str = None, configTemplate: Dict[str, Any] = None)

Bases: CamelModel

client: Client

config_template: Dict[str, Any]

static create(client: Client, package_id: str | None = None, handle: str | None = None, filename: str | None = None, filebytes: bytes | None = None, config_template: Dict[str, Any] | None = None, hosting_handler: str | None = None) → PackageVersion

delete() → PackageVersion

Delete this package version. If this package is public and another user has created an instance of this version, this method will throw an error and the PackageVersion will not be deleted. Deleting the PackageVersion will delete any instances of it that you have created.

handle: str

id: str

package_id: str

classmethod parse_obj(obj: Any) → BaseModel

Module contents

class steamship.data.package.Package(*, client: Client = None, id: str = None, handle: str = None, userId: str = None, profile: Manifest | None = None, description: str | None = None, readme: str | None = None, isPublic: bool = False)

Bases: CamelModel

client: Client

static create(client: Client, handle: str = None, profile: Manifest = None, is_public=False, fetch_if_exists=False) → Package

delete() → Package

Delete this package. If this package is public and another user has created an instance of it, this method will throw an error and the package will not be deleted. Deleting the package will delete any versions and instances of it that you have created.

description: str | None

static get(client: Client, handle: str) → Package

handle: str

id: str

is_public: bool

classmethod parse_obj(obj: Any) → BaseModel

profile: Manifest | None

readme: str | None

update(client: Client) → Package

user_id: str

class steamship.data.package.PackageInstance(*, client: Client = None, id: str = None, handle: str = None, packageId: str = None, packageHandle: str | None = None, userHandle: str = None, packageVersionId: str = None, packageVersionHandle: str | None = None, userId: str = None, invocationURL: str = None, config: Dict[str, Any] = None, workspaceId: str = None, workspaceHandle: str = None, initStatus: InvocableInitStatus | None = None, createdAt: datetime | None = None)

Bases: CamelModel

blocks_from_invoke(path: str, verb: Verb = Verb.POST, timeout_s: float | None = None, **kwargs) → List[Block]

client: Client

config: Dict[str, Any]

static create(client: Client, package_id: str = None, package_handle: str = None, package_version_id: str = None, package_version_handle: str = None, handle: str = None, fetch_if_exists: bool = None, config: Dict[str, Any] = None) → PackageInstance

static create_local_development_instance(client: Client, local_development_url: str, package_id: str = None, package_handle: str = None, handle: str = None, fetch_if_exists: bool = True, config: Dict[str, Any] = None) → PackageInstance

created_at: datetime | None

delete() → PackageInstance

full_url_for(path: str)

static get(client: Client, handle: str) → PackageInstance

handle: str

id: str

init_status: InvocableInitStatus | None

invocation_url: str

invoke(path: str, verb: Verb = Verb.POST, timeout_s: float | None = None, **kwargs)

static list(client: Client, package_id: str | None = None, package_version_id: str | None = None, include_workspace: bool | None = None, across_workspaces: bool | None = None, page_size: int | None = None, page_token: str | None = None, sort_order: SortOrder | None = SortOrder.DESC) → ListPackageInstancesResponse

load_missing_workspace_handle()

package_handle: str | None

package_id: str

package_version_handle: str | None

package_version_id: str

classmethod parse_obj(obj: Any) → BaseModel

refresh_init_status()

task_from_invoke(path: str, verb: Verb = Verb.POST, timeout_s: float | None = None, **kwargs) → Task

user_handle: str

user_id: str

wait_for_init(max_timeout_s: float = 180, retry_delay_s: float = 1)

Polls and blocks until the init has succeeded or failed (or timeout reached).

Parameters:

• max_timeout_s (int) – Max timeout in seconds. Default: 180s. After this timeout, an exception will be thrown.

• retry_delay_s (float) – Delay between status checks. Default: 1s.

workspace_handle: str

workspace_id: str

class steamship.data.package.PackageVersion(*, client: Client = None, id: str = None, packageId: str = None, handle: str = None, configTemplate: Dict[str, Any] = None)

Bases: CamelModel

client: Client

config_template: Dict[str, Any]

static create(client: Client, package_id: str | None = None, handle: str | None = None, filename: str | None = None, filebytes: bytes | None = None, config_template: Dict[str, Any] | None = None, hosting_handler: str | None = None) → PackageVersion

delete() → PackageVersion

Delete this package version. If this package is public and another user has created an instance of this version, this method will throw an error and the PackageVersion will not be deleted. Deleting the PackageVersion will delete any instances of it that you have created.

handle: str

id: str

package_id: str

classmethod parse_obj(obj: Any) → BaseModel