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: Optional[Manifest] = None, description: Optional[str] = None, readme: Optional[str] = None, isPublic: bool = False)

Bases: CamelModel

client: Client

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

description: Optional[str]

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

handle: str

id: str

is_public: bool

classmethod parse_obj(obj: Any) → BaseModel

profile: Optional[Manifest]

readme: Optional[str]

update(client: Client) → Package

user_id: str

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

Bases: CreateRequest

is_public: bool

profile: Optional[Manifest]

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

Bases: UpdateRequest

description: Optional[str]

handle: Optional[str]

id: Optional[str]

profile: Optional[Manifest]

readme: Optional[str]

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)

Bases: Request

config: Dict[str, Any]

fetch_if_exists: bool

handle: str

id: str

package_handle: str

package_id: str

package_version_handle: str

package_version_id: str

workspace_id: str

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

Bases: CamelModel

client: Client

config: Dict[str, Any]

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

delete() → PackageInstance

full_url_for(path: str)

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

handle: str

id: str

init_status: Optional[InvocableInitStatus]

invocation_url: str

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

load_missing_workspace_handle()

package_handle: Optional[str]

package_id: str

package_version_handle: Optional[str]

package_version_id: str

classmethod parse_obj(obj: Any) → BaseModel

refresh_init_status()

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: Optional[str] = None, handle: Optional[str] = None, filename: Optional[str] = None, filebytes: Optional[bytes] = None, config_template: Optional[Dict[str, Any]] = None, hosting_handler: Optional[str] = None) → PackageVersion

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: Optional[Manifest] = None, description: Optional[str] = None, readme: Optional[str] = None, isPublic: bool = False)

Bases: CamelModel

client: Client

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

description: Optional[str]

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

handle: str

id: str

is_public: bool

classmethod parse_obj(obj: Any) → BaseModel

profile: Optional[Manifest]

readme: Optional[str]

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: Optional[str] = None, userHandle: str = None, packageVersionId: str = None, packageVersionHandle: Optional[str] = None, userId: str = None, invocationURL: str = None, config: Dict[str, Any] = None, workspaceId: str = None, workspaceHandle: str = None, initStatus: Optional[InvocableInitStatus] = None)

Bases: CamelModel

client: Client

config: Dict[str, Any]

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

delete() → PackageInstance

full_url_for(path: str)

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

handle: str

id: str

init_status: Optional[InvocableInitStatus]

invocation_url: str

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

load_missing_workspace_handle()

package_handle: Optional[str]

package_id: str

package_version_handle: Optional[str]

package_version_id: str

classmethod parse_obj(obj: Any) → BaseModel

refresh_init_status()

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: Optional[str] = None, handle: Optional[str] = None, filename: Optional[str] = None, filebytes: Optional[bytes] = None, config_template: Optional[Dict[str, Any]] = None, hosting_handler: Optional[str] = None) → PackageVersion

handle: str

id: str

package_id: str

classmethod parse_obj(obj: Any) → BaseModel