Projects Module¶
Registry¶
RegistryManager(adapter: Any)
¶
Registry manager for project CRUD operations.
Provides methods to create, retrieve, update, and list projects. All methods return Project entities that give access to project-scoped operations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
adapter
|
Any
|
adapter (FluidizeSDK or LocalAdapter) |
required |
create(project_id: str, label: str = '', description: str = '', location: str = '', status: str = '') -> ProjectManager
¶
Create a new project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_id
|
str
|
Unique identifier for the project |
required |
label
|
str
|
Display label for the project |
''
|
description
|
str
|
Project description |
''
|
location
|
str
|
Project location |
''
|
status
|
str
|
Project status |
''
|
Returns:
| Type | Description |
|---|---|
ProjectManager
|
Created project wrapped in Project class |
get(project_id: str) -> ProjectManager
¶
Get a project by ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_id
|
str
|
The project ID |
required |
Returns:
| Type | Description |
|---|---|
ProjectManager
|
Project wrapped in Project class |
list() -> list[ProjectManager]
¶
List all projects.
Returns:
| Type | Description |
|---|---|
list[ProjectManager]
|
List of projects wrapped in Project class |
update(project_id: str, label: Optional[str] = None, description: Optional[str] = None, location: Optional[str] = None, status: Optional[str] = None) -> ProjectManager
¶
Update an existing project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_id
|
str
|
The project ID to update |
required |
label
|
Optional[str]
|
New label |
None
|
description
|
Optional[str]
|
New description |
None
|
location
|
Optional[str]
|
New location |
None
|
status
|
Optional[str]
|
New status |
None
|
Returns:
| Type | Description |
|---|---|
ProjectManager
|
Updated project wrapped in Project class |
Project¶
ProjectManager(adapter: Any, project_summary: ProjectSummary)
¶
Project manager that wraps project data and provides access to scoped managers.
Provides convenient access to graph and runs operations for this specific project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
adapter
|
Any
|
adapter (FluidizeSDK or LocalAdapter) |
required |
project_summary
|
ProjectSummary
|
The underlying project data |
required |
graph: GraphManager
property
¶
Get the graph manager for this project.
Returns:
| Type | Description |
|---|---|
GraphManager
|
GraphManager manager scoped to this project |
runs: RunsManager
property
¶
Get the runs manager for this project.
Returns:
| Type | Description |
|---|---|
RunsManager
|
ProjectRuns manager scoped to this project |
id: str
property
¶
Get project ID.
Returns:
| Type | Description |
|---|---|
str
|
The project ID |
label: Optional[str]
property
¶
Get project label.
Returns:
| Type | Description |
|---|---|
Optional[str]
|
The project label |
description: Optional[str]
property
¶
Get project description.
Returns:
| Type | Description |
|---|---|
Optional[str]
|
The project description |
location: Optional[str]
property
¶
Get project location.
Returns:
| Type | Description |
|---|---|
Optional[str]
|
The project location |
status: Optional[str]
property
¶
Get project status.
Returns:
| Type | Description |
|---|---|
Optional[str]
|
The project status |
metadata_version: str
property
¶
Get project metadata version.
Returns:
| Type | Description |
|---|---|
str
|
The project metadata version |
created_at: Optional[str]
property
¶
Get project creation timestamp.
Returns:
| Type | Description |
|---|---|
Optional[str]
|
The project creation timestamp |
updated_at: Optional[str]
property
¶
Get project update timestamp.
Returns:
| Type | Description |
|---|---|
Optional[str]
|
The project update timestamp |
to_dict() -> dict[str, Any]
¶
Convert project to dictionary representation.
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Dictionary representation of the project |