rebase.Project

Group functions, steps, and workflows for deployment.

Signature

class rebase.Project(
    name: str,
    *,
    description: str | None = None,
    source_mode: str | None = None,
    repo_owner: str | None = None,
    repo_name: str | None = None,
    repo_path: str | None = None,
    deploy_source: str | None = None,
    client: rebase.Client | None = None,
)

Project is the main grouping object for Rebase SDK targets. Most code should create one with rebase.project(...).

Helper

rebase.project(
    name: str,
    *,
    description: str | None = None,
    source_mode: str | None = None,
    repo_owner: str | None = None,
    repo_name: str | None = None,
    repo_path: str | None = None,
    deploy_source: str | None = None,
) -> rebase.Project

Parameters

ParameterTypeDescription
namestrProject name inside the current workspace.
description`strNone`
source_mode`strNone`
repo_owner`strNone`
repo_name`strNone`
repo_path`strNone`
deploy_source`strNone`
client`rebase.ClientNone`

Methods

project.function(...) -> Callable[[Callable], rebase.Function]
project.step(...) -> Callable[[Callable], rebase.Step]
project.workflow(...) -> Callable[[Callable], rebase.Workflow]
project.asgi_app(...) -> Callable[[Callable], rebase.ASGIApp]
project.deploy(*, replace: bool = False, deploy_source: str | None = None,
               environment: str | None = None) -> rebase.Project
MethodDescription
function(...)Decorator for functions in this project.
step(...)Decorator for workflow steps in this project.
workflow(...)Decorator for workflows in this project.
asgi_app(...)Decorator for ASGI web apps in this project.
deploy()Ensure the project exists and deploy registered targets.

On this page