Project

A class representing a project in the Union API.

Attributes

Attribute	Type	Description
pb2		This attribute stores a project_service_pb2.Project object, which represents the underlying protobuf message for the project in the Union API.

---

Methods

---

get()

@classmethod
def get(
    name: str
) - > [Project](project.md?sid=flyte_remote__project_project)

Get a project by name.

Parameters

Name	Type	Description
name	str	The name of the project.

Returns

Type	Description
[Project](project.md?sid=flyte_remote__project_project)

---

create()

@classmethod
def create(
    id: str,
    name: str,
    description: str = "",
    labels: Dict[str, str]| None = None
) - > [Project](project.md?sid=flyte_remote__project_project)

Create a new project.

Parameters

Name	Type	Description
id	str	The unique identifier for the project.
name	str	The display name for the project.
description	str = ""	A description for the project.
labels	`Dict[str, str]	None` = None

Returns

Type	Description
[Project](project.md?sid=flyte_remote__project_project)

---

update()

@classmethod
def update(
    id: str,
    name: str | None = None,
    description: str | None = None,
    labels: Dict[str, str]| None = None,
    state: Literal["archived", "active"]| None = None
) - > [Project](project.md?sid=flyte_remote__project_project)

Update an existing project.

Parameters

Name	Type	Description
id	str	The id of the project to update.
name	`str	None` = None
description	`str	None` = None
labels	`Dict[str, str]	None` = None
state	`Literal["archived", "active"]	None` = None

Returns

Type	Description
[Project](project.md?sid=flyte_remote__project_project)

---

archive()

@classmethod
def archive() - > [Project](project.md?sid=flyte_remote__project_project)

Archive this project.

Returns

Type	Description
[Project](project.md?sid=flyte_remote__project_project)

---

unarchive()

@classmethod
def unarchive() - > [Project](project.md?sid=flyte_remote__project_project)

Unarchive (activate) this project.

Returns

Type	Description
[Project](project.md?sid=flyte_remote__project_project)

---

listall()

@classmethod
def listall(
    filters: str | None = None,
    sort_by: Tuple[str, Literal["asc", "desc"]]| None = None,
    archived: bool = False
) - > Union[AsyncIterator[[Project](project.md?sid=flyte_remote__project_project)], Iterator[[Project](project.md?sid=flyte_remote__project_project)]]

List all projects. By default, lists active (unarchived) projects. Set archived=True to list archived projects instead.

Parameters

Name	Type	Description
filters	`str	None` = None
sort_by	`Tuple[str, Literal["asc", "desc"]]	None` = None
archived	bool = False	If True, list archived projects. If False (default), list active projects.

Returns

Type	Description
Union[AsyncIterator[[Project](project.md?sid=flyte_remote__project_project)], Iterator[[Project](project.md?sid=flyte_remote__project_project)]]	An iterator of projects.

---