zenml-nightly 0.75.0.dev20250313__py3-none-any.whl → 0.75.0.dev20250315__py3-none-any.whl

zenml/zen_stores/migrations/versions/41b28cae31ce_make_artifacts_workspace_scoped.py

@@ -15,8 +15,8 @@ from sqlalchemy.orm import Session
 from sqlalchemy.sql import column, table
 
 from zenml.constants import (
-    DEFAULT_WORKSPACE_NAME,
-    ENV_ZENML_DEFAULT_WORKSPACE_NAME,
+    DEFAULT_PROJECT_NAME,
+    ENV_ZENML_DEFAULT_PROJECT_NAME,
 )
 
 # revision identifiers, used by Alembic.
@@ -52,7 +52,7 @@ def upgrade() -> None:
     )
 
     default_workspace_name = os.getenv(
-        ENV_ZENML_DEFAULT_WORKSPACE_NAME, DEFAULT_WORKSPACE_NAME
+        ENV_ZENML_DEFAULT_PROJECT_NAME, DEFAULT_PROJECT_NAME
     )
 
     default_workspace_query = sa.text(

zenml/zen_stores/migrations/versions/cbc6acd71f92_add_workspace_display_name.py

@@ -0,0 +1,58 @@
+"""add workspace display name [cbc6acd71f92].
+
+Revision ID: cbc6acd71f92
+Revises: 9e7bf0970266
+Create Date: 2025-03-12 19:38:57.126846
+
+"""
+
+import sqlalchemy as sa
+import sqlmodel
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "cbc6acd71f92"
+down_revision = "9e7bf0970266"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    """Upgrade database schema and/or data, creating a new revision."""
+    with op.batch_alter_table("workspace", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "display_name",
+                sqlmodel.sql.sqltypes.AutoString(),
+                nullable=True,
+            )
+        )
+
+    # Migrate existing workspace names to display_name
+    connection = op.get_bind()
+    meta = sa.MetaData()
+    meta.reflect(bind=connection, only=("workspace",))
+    workspace_table = sa.Table("workspace", meta)
+
+    for workspace_id, workspace_name in connection.execute(
+        sa.select(
+            workspace_table.c.id,
+            workspace_table.c.name,
+        )
+    ):
+        connection.execute(
+            sa.update(workspace_table)
+            .where(workspace_table.c.id == workspace_id)
+            .values(display_name=workspace_name)
+        )
+
+    with op.batch_alter_table("workspace", schema=None) as batch_op:
+        batch_op.alter_column(
+            "display_name", existing_type=sa.String(50), nullable=False
+        )
+
+
+def downgrade() -> None:
+    """Downgrade database schema and/or data back to the previous revision."""
+    with op.batch_alter_table("workspace", schema=None) as batch_op:
+        batch_op.drop_column("display_name")

zenml/zen_stores/rest_zen_store.py

@@ -80,6 +80,7 @@ from zenml.constants import (
     PIPELINE_BUILDS,
     PIPELINE_DEPLOYMENTS,
     PIPELINES,
+    PROJECTS,
     RUN_METADATA,
     RUN_TEMPLATES,
     RUNS,
@@ -108,7 +109,6 @@ from zenml.constants import (
     TRIGGERS,
     USERS,
     VERSION_1,
-    WORKSPACES,
 )
 from zenml.enums import (
     APITokenType,
@@ -203,6 +203,10 @@ from zenml.models import (
     PipelineRunResponse,
     PipelineRunUpdate,
     PipelineUpdate,
+    ProjectFilter,
+    ProjectRequest,
+    ProjectResponse,
+    ProjectUpdate,
     RunMetadataRequest,
     RunTemplateFilter,
     RunTemplateRequest,
@@ -259,10 +263,6 @@ from zenml.models import (
     UserRequest,
     UserResponse,
     UserUpdate,
-    WorkspaceFilter,
-    WorkspaceRequest,
-    WorkspaceResponse,
-    WorkspaceUpdate,
 )
 from zenml.service_connectors.service_connector_registry import (
     service_connector_registry,
@@ -1086,13 +1086,13 @@ class RestZenStore(BaseZenStore):
 
     def prune_artifact_versions(
         self,
-        workspace_name_or_id: Union[str, UUID],
+        project_name_or_id: Union[str, UUID],
         only_versions: bool = True,
     ) -> None:
         """Prunes unused artifact versions and their artifacts.
 
         Args:
-            workspace_name_or_id: The workspace name or ID to prune artifact
+            project_name_or_id: The project name or ID to prune artifact
                 versions for.
             only_versions: Only delete artifact versions, keeping artifacts
         """
@@ -1100,7 +1100,7 @@ class RestZenStore(BaseZenStore):
             path=ARTIFACT_VERSIONS,
             params={
                 "only_versions": only_versions,
-                "workspace_name_or_id": workspace_name_or_id,
+                "project_name_or_id": project_name_or_id,
             },
         )
 
@@ -2112,10 +2112,8 @@ class RestZenStore(BaseZenStore):
         The new secret is also validated against the scoping rules enforced in
         the secrets store:
 
-          - only one workspace-scoped secret with the given name can exist
-            in the target workspace.
-          - only one user-scoped secret with the given name can exist in the
-            target workspace for the target user.
+          - only one private secret with the given name can exist.
+          - only one public secret with the given name can exist.
 
         Args:
             secret: The secret to create.
@@ -2190,10 +2188,8 @@ class RestZenStore(BaseZenStore):
         If the update includes a change of name or scope, the scoping rules
         enforced in the secrets store are used to validate the update:
 
-          - only one workspace-scoped secret with the given name can exist
-            in the target workspace.
-          - only one user-scoped secret with the given name can exist in the
-            target workspace for the target user.
+          - only one private secret with the given name can exist.
+          - only one public secret with the given name can exist.
 
         Args:
             secret_id: The ID of the secret to be updated.
@@ -3339,96 +3335,94 @@ class RestZenStore(BaseZenStore):
             route=USERS,
         )
 
-    # ----------------------------- Workspaces -----------------------------
+    # ----------------------------- Projects -----------------------------
 
-    def create_workspace(
-        self, workspace: WorkspaceRequest
-    ) -> WorkspaceResponse:
-        """Creates a new workspace.
+    def create_project(self, project: ProjectRequest) -> ProjectResponse:
+        """Creates a new project.
 
         Args:
-            workspace: The workspace to create.
+            project: The project to create.
 
         Returns:
-            The newly created workspace.
+            The newly created project.
         """
         return self._create_resource(
-            resource=workspace,
-            route=WORKSPACES,
-            response_model=WorkspaceResponse,
+            resource=project,
+            route=PROJECTS,
+            response_model=ProjectResponse,
         )
 
-    def get_workspace(
-        self, workspace_name_or_id: Union[UUID, str], hydrate: bool = True
-    ) -> WorkspaceResponse:
-        """Get an existing workspace by name or ID.
+    def get_project(
+        self, project_name_or_id: Union[UUID, str], hydrate: bool = True
+    ) -> ProjectResponse:
+        """Get an existing project by name or ID.
 
         Args:
-            workspace_name_or_id: Name or ID of the workspace to get.
+            project_name_or_id: Name or ID of the project to get.
             hydrate: Flag deciding whether to hydrate the output model(s)
                 by including metadata fields in the response.
 
         Returns:
-            The requested workspace.
+            The requested project.
         """
         return self._get_resource(
-            resource_id=workspace_name_or_id,
-            route=WORKSPACES,
-            response_model=WorkspaceResponse,
+            resource_id=project_name_or_id,
+            route=PROJECTS,
+            response_model=ProjectResponse,
             params={"hydrate": hydrate},
         )
 
-    def list_workspaces(
+    def list_projects(
         self,
-        workspace_filter_model: WorkspaceFilter,
+        project_filter_model: ProjectFilter,
         hydrate: bool = False,
-    ) -> Page[WorkspaceResponse]:
-        """List all workspace matching the given filter criteria.
+    ) -> Page[ProjectResponse]:
+        """List all projects matching the given filter criteria.
 
         Args:
-            workspace_filter_model: All filter parameters including pagination
+            project_filter_model: All filter parameters including pagination
                 params.
             hydrate: Flag deciding whether to hydrate the output model(s)
                 by including metadata fields in the response.
 
         Returns:
-            A list of all workspace matching the filter criteria.
+            A list of all projects matching the filter criteria.
         """
         return self._list_paginated_resources(
-            route=WORKSPACES,
-            response_model=WorkspaceResponse,
-            filter_model=workspace_filter_model,
+            route=PROJECTS,
+            response_model=ProjectResponse,
+            filter_model=project_filter_model,
             params={"hydrate": hydrate},
         )
 
-    def update_workspace(
-        self, workspace_id: UUID, workspace_update: WorkspaceUpdate
-    ) -> WorkspaceResponse:
-        """Update an existing workspace.
+    def update_project(
+        self, project_id: UUID, project_update: ProjectUpdate
+    ) -> ProjectResponse:
+        """Update an existing project.
 
         Args:
-            workspace_id: The ID of the workspace to be updated.
-            workspace_update: The update to be applied to the workspace.
+            project_id: The ID of the project to be updated.
+            project_update: The update to be applied to the project.
 
         Returns:
-            The updated workspace.
+            The updated project.
         """
         return self._update_resource(
-            resource_id=workspace_id,
-            resource_update=workspace_update,
-            route=WORKSPACES,
-            response_model=WorkspaceResponse,
+            resource_id=project_id,
+            resource_update=project_update,
+            route=PROJECTS,
+            response_model=ProjectResponse,
         )
 
-    def delete_workspace(self, workspace_name_or_id: Union[str, UUID]) -> None:
-        """Deletes a workspace.
+    def delete_project(self, project_name_or_id: Union[str, UUID]) -> None:
+        """Deletes a project.
 
         Args:
-            workspace_name_or_id: Name or ID of the workspace to delete.
+            project_name_or_id: Name or ID of the project to delete.
         """
         self._delete_resource(
-            resource_id=workspace_name_or_id,
-            route=WORKSPACES,
+            resource_id=project_name_or_id,
+            route=PROJECTS,
         )
 
     # --------------------------- Model ---------------------------
@@ -4104,7 +4098,7 @@ class RestZenStore(BaseZenStore):
                     "password": password,
                 }
             elif self.server_info.is_pro_server():
-                # ZenML Pro tenants use a proprietary authorization grant
+                # ZenML Pro workspaces use a proprietary authorization grant
                 # where the ZenML Pro API session token is exchanged for a
                 # regular ZenML server access token.
 
@@ -4209,7 +4203,6 @@ class RestZenStore(BaseZenStore):
             # Retries are triggered for idempotent HTTP methods (GET, HEAD, PUT,
             # OPTIONS and DELETE) on specific HTTP status codes:
             #
-            #     500: Internal Server Error.
             #     502: Bad Gateway.
             #     503: Service Unavailable.
             #     504: Gateway Timeout.
@@ -4236,7 +4229,6 @@ class RestZenStore(BaseZenStore):
                 status_forcelist=[
                     408,  # Request Timeout
                     429,  # Too Many Requests
-                    500,  # Internal Server Error
                     502,  # Bad Gateway
                     503,  # Service Unavailable
                     504,  # Gateway Timeout

zenml/zen_stores/schemas/__init__.py

@@ -38,7 +38,7 @@ from zenml.zen_stores.schemas.pipeline_deployment_schemas import (
 )
 from zenml.zen_stores.schemas.pipeline_run_schemas import PipelineRunSchema
 from zenml.zen_stores.schemas.pipeline_schemas import PipelineSchema
-from zenml.zen_stores.schemas.workspace_schemas import WorkspaceSchema
+from zenml.zen_stores.schemas.project_schemas import ProjectSchema
 from zenml.zen_stores.schemas.run_metadata_schemas import (
     RunMetadataResourceSchema,
     RunMetadataSchema,
@@ -118,5 +118,5 @@ __all__ = [
     "ModelVersionSchema",
     "ModelVersionArtifactSchema",
     "ModelVersionPipelineRunSchema",
-    "WorkspaceSchema",
+    "ProjectSchema",
 ]

zenml/zen_stores/schemas/action_schemas.py

@@ -32,9 +32,9 @@ from zenml.models import (
 )
 from zenml.utils.time_utils import utc_now
 from zenml.zen_stores.schemas.base_schemas import NamedSchema
+from zenml.zen_stores.schemas.project_schemas import ProjectSchema
 from zenml.zen_stores.schemas.schema_utils import build_foreign_key_field
 from zenml.zen_stores.schemas.user_schemas import UserSchema
-from zenml.zen_stores.schemas.workspace_schemas import WorkspaceSchema
 
 if TYPE_CHECKING:
     from zenml.zen_stores.schemas import TriggerSchema
@@ -47,20 +47,20 @@ class ActionSchema(NamedSchema, table=True):
     __table_args__ = (
         UniqueConstraint(
             "name",
-            "workspace_id",
-            name="unique_action_name_in_workspace",
+            "project_id",
+            name="unique_action_name_in_project",
         ),
     )
 
-    workspace_id: UUID = build_foreign_key_field(
+    project_id: UUID = build_foreign_key_field(
         source=__tablename__,
-        target=WorkspaceSchema.__tablename__,
-        source_column="workspace_id",
+        target=ProjectSchema.__tablename__,
+        source_column="project_id",
         target_column="id",
         ondelete="CASCADE",
         nullable=False,
     )
-    workspace: "WorkspaceSchema" = Relationship(back_populates="actions")
+    project: "ProjectSchema" = Relationship(back_populates="actions")
 
     user_id: Optional[UUID] = build_foreign_key_field(
         source=__tablename__,
@@ -111,7 +111,7 @@ class ActionSchema(NamedSchema, table=True):
         """
         return cls(
             name=request.name,
-            workspace_id=request.workspace,
+            project_id=request.project,
             user_id=request.user,
             configuration=base64.b64encode(
                 json.dumps(
@@ -178,7 +178,7 @@ class ActionSchema(NamedSchema, table=True):
         metadata = None
         if include_metadata:
             metadata = ActionResponseMetadata(
-                workspace=self.workspace.to_model(),
+                project=self.project.to_model(),
                 configuration=json.loads(
                     base64.b64decode(self.configuration).decode()
                 ),

zenml/zen_stores/schemas/artifact_schemas.py

@@ -44,6 +44,7 @@ from zenml.models.v2.core.artifact import ArtifactRequest
 from zenml.utils.time_utils import utc_now
 from zenml.zen_stores.schemas.base_schemas import BaseSchema, NamedSchema
 from zenml.zen_stores.schemas.component_schemas import StackComponentSchema
+from zenml.zen_stores.schemas.project_schemas import ProjectSchema
 from zenml.zen_stores.schemas.schema_utils import build_foreign_key_field
 from zenml.zen_stores.schemas.step_run_schemas import (
     StepRunInputArtifactSchema,
@@ -51,7 +52,6 @@ from zenml.zen_stores.schemas.step_run_schemas import (
 )
 from zenml.zen_stores.schemas.user_schemas import UserSchema
 from zenml.zen_stores.schemas.utils import RunMetadataInterface
-from zenml.zen_stores.schemas.workspace_schemas import WorkspaceSchema
 
 if TYPE_CHECKING:
     from zenml.zen_stores.schemas.artifact_visualization_schemas import (
@@ -71,8 +71,8 @@ class ArtifactSchema(NamedSchema, table=True):
     __table_args__ = (
         UniqueConstraint(
             "name",
-            "workspace_id",
-            name="unique_artifact_name_in_workspace",
+            "project_id",
+            name="unique_artifact_name_in_project",
         ),
     )
 
@@ -92,15 +92,15 @@ class ArtifactSchema(NamedSchema, table=True):
         ),
     )
 
-    workspace_id: UUID = build_foreign_key_field(
+    project_id: UUID = build_foreign_key_field(
         source=__tablename__,
-        target=WorkspaceSchema.__tablename__,
-        source_column="workspace_id",
+        target=ProjectSchema.__tablename__,
+        source_column="project_id",
         target_column="id",
         ondelete="CASCADE",
         nullable=False,
     )
-    workspace: "WorkspaceSchema" = Relationship()
+    project: "ProjectSchema" = Relationship()
 
     user_id: Optional[UUID] = build_foreign_key_field(
         source=__tablename__,
@@ -156,7 +156,7 @@ class ArtifactSchema(NamedSchema, table=True):
         return cls(
             name=artifact_request.name,
             has_custom_name=artifact_request.has_custom_name,
-            workspace_id=artifact_request.workspace,
+            project_id=artifact_request.project,
             user_id=artifact_request.user,
         )
 
@@ -198,7 +198,7 @@ class ArtifactSchema(NamedSchema, table=True):
         if include_metadata:
             metadata = ArtifactResponseMetadata(
                 has_custom_name=self.has_custom_name,
-                workspace=self.workspace.to_model(),
+                project=self.project.to_model(),
             )
 
         return ArtifactResponse(
@@ -281,10 +281,10 @@ class ArtifactVersionSchema(BaseSchema, RunMetadataInterface, table=True):
         ondelete="SET NULL",
         nullable=True,
     )
-    workspace_id: UUID = build_foreign_key_field(
+    project_id: UUID = build_foreign_key_field(
         source=__tablename__,
-        target=WorkspaceSchema.__tablename__,
-        source_column="workspace_id",
+        target=ProjectSchema.__tablename__,
+        source_column="project_id",
         target_column="id",
         ondelete="CASCADE",
         nullable=False,
@@ -295,9 +295,7 @@ class ArtifactVersionSchema(BaseSchema, RunMetadataInterface, table=True):
     user: Optional["UserSchema"] = Relationship(
         back_populates="artifact_versions"
     )
-    workspace: "WorkspaceSchema" = Relationship(
-        back_populates="artifact_versions"
-    )
+    project: "ProjectSchema" = Relationship(back_populates="artifact_versions")
     run_metadata: List["RunMetadataSchema"] = Relationship(
         sa_relationship_kwargs=dict(
             secondary="run_metadata_resource",
@@ -353,7 +351,7 @@ class ArtifactVersionSchema(BaseSchema, RunMetadataInterface, table=True):
             version=str(artifact_version_request.version),
             version_number=version_number,
             artifact_store_id=artifact_version_request.artifact_store_id,
-            workspace_id=artifact_version_request.workspace,
+            project_id=artifact_version_request.project,
             user_id=artifact_version_request.user,
             type=artifact_version_request.type.value,
             uri=artifact_version_request.uri,
@@ -429,7 +427,7 @@ class ArtifactVersionSchema(BaseSchema, RunMetadataInterface, table=True):
         metadata = None
         if include_metadata:
             metadata = ArtifactVersionResponseMetadata(
-                workspace=self.workspace.to_model(),
+                project=self.project.to_model(),
                 producer_step_run_id=producer_step_run_id,
                 visualizations=[v.to_model() for v in self.visualizations],
                 run_metadata=self.fetch_metadata(),

zenml/zen_stores/schemas/code_repository_schemas.py

@@ -33,9 +33,9 @@ from zenml.models import (
 )
 from zenml.utils.time_utils import utc_now
 from zenml.zen_stores.schemas.base_schemas import BaseSchema, NamedSchema
+from zenml.zen_stores.schemas.project_schemas import ProjectSchema
 from zenml.zen_stores.schemas.schema_utils import build_foreign_key_field
 from zenml.zen_stores.schemas.user_schemas import UserSchema
-from zenml.zen_stores.schemas.workspace_schemas import WorkspaceSchema
 
 
 class CodeRepositorySchema(NamedSchema, table=True):
@@ -45,22 +45,20 @@ class CodeRepositorySchema(NamedSchema, table=True):
     __table_args__ = (
         UniqueConstraint(
             "name",
-            "workspace_id",
-            name="unique_code_repository_name_in_workspace",
+            "project_id",
+            name="unique_code_repository_name_in_project",
         ),
     )
 
-    workspace_id: UUID = build_foreign_key_field(
+    project_id: UUID = build_foreign_key_field(
         source=__tablename__,
-        target=WorkspaceSchema.__tablename__,
-        source_column="workspace_id",
+        target=ProjectSchema.__tablename__,
+        source_column="project_id",
         target_column="id",
         ondelete="CASCADE",
         nullable=False,
     )
-    workspace: "WorkspaceSchema" = Relationship(
-        back_populates="code_repositories"
-    )
+    project: "ProjectSchema" = Relationship(back_populates="code_repositories")
 
     user_id: Optional[UUID] = build_foreign_key_field(
         source=__tablename__,
@@ -94,7 +92,7 @@ class CodeRepositorySchema(NamedSchema, table=True):
         """
         return cls(
             name=request.name,
-            workspace_id=request.workspace,
+            project_id=request.project,
             user_id=request.user,
             config=json.dumps(request.config),
             source=request.source.model_dump_json(),
@@ -129,7 +127,7 @@ class CodeRepositorySchema(NamedSchema, table=True):
         metadata = None
         if include_metadata:
             metadata = CodeRepositoryResponseMetadata(
-                workspace=self.workspace.to_model(),
+                project=self.project.to_model(),
                 config=json.loads(self.config),
                 description=self.description,
             )
@@ -170,15 +168,15 @@ class CodeReferenceSchema(BaseSchema, table=True):
 
     __tablename__ = "code_reference"
 
-    workspace_id: UUID = build_foreign_key_field(
+    project_id: UUID = build_foreign_key_field(
         source=__tablename__,
-        target=WorkspaceSchema.__tablename__,
-        source_column="workspace_id",
+        target=ProjectSchema.__tablename__,
+        source_column="project_id",
         target_column="id",
         ondelete="CASCADE",
         nullable=False,
     )
-    workspace: "WorkspaceSchema" = Relationship()
+    project: "ProjectSchema" = Relationship()
 
     code_repository_id: UUID = build_foreign_key_field(
         source=__tablename__,
@@ -195,19 +193,19 @@ class CodeReferenceSchema(BaseSchema, table=True):
 
     @classmethod
     def from_request(
-        cls, request: "CodeReferenceRequest", workspace_id: UUID
+        cls, request: "CodeReferenceRequest", project_id: UUID
     ) -> "CodeReferenceSchema":
         """Convert a `CodeReferenceRequest` to a `CodeReferenceSchema`.
 
         Args:
             request: The request model to convert.
-            workspace_id: The workspace ID.
+            project_id: The project ID.
 
         Returns:
             The converted schema.
         """
         return cls(
-            workspace_id=workspace_id,
+            project_id=project_id,
             commit=request.commit,
             subdirectory=request.subdirectory,
             code_repository_id=request.code_repository,

zenml/zen_stores/schemas/event_source_schemas.py

@@ -33,10 +33,10 @@ from zenml.models import (
 from zenml.utils.json_utils import pydantic_encoder
 from zenml.utils.time_utils import utc_now
 from zenml.zen_stores.schemas.base_schemas import NamedSchema
+from zenml.zen_stores.schemas.project_schemas import ProjectSchema
 from zenml.zen_stores.schemas.schema_utils import build_foreign_key_field
 from zenml.zen_stores.schemas.user_schemas import UserSchema
 from zenml.zen_stores.schemas.utils import get_page_from_list
-from zenml.zen_stores.schemas.workspace_schemas import WorkspaceSchema
 
 if TYPE_CHECKING:
     from zenml.zen_stores.schemas import TriggerSchema
@@ -49,20 +49,20 @@ class EventSourceSchema(NamedSchema, table=True):
     __table_args__ = (
         UniqueConstraint(
             "name",
-            "workspace_id",
-            name="unique_event_source_name_in_workspace",
+            "project_id",
+            name="unique_event_source_name_in_project",
         ),
     )
 
-    workspace_id: UUID = build_foreign_key_field(
+    project_id: UUID = build_foreign_key_field(
         source=__tablename__,
-        target=WorkspaceSchema.__tablename__,
-        source_column="workspace_id",
+        target=ProjectSchema.__tablename__,
+        source_column="project_id",
         target_column="id",
         ondelete="CASCADE",
         nullable=False,
     )
-    workspace: "WorkspaceSchema" = Relationship(back_populates="event_sources")
+    project: "ProjectSchema" = Relationship(back_populates="event_sources")
 
     user_id: Optional[UUID] = build_foreign_key_field(
         source=__tablename__,
@@ -96,7 +96,7 @@ class EventSourceSchema(NamedSchema, table=True):
             The converted schema.
         """
         return cls(
-            workspace_id=request.workspace,
+            project_id=request.project,
             user_id=request.user,
             flavor=request.flavor,
             plugin_subtype=request.plugin_subtype,
@@ -157,7 +157,7 @@ class EventSourceSchema(NamedSchema, table=True):
         metadata = None
         if include_metadata:
             metadata = EventSourceResponseMetadata(
-                workspace=self.workspace.to_model(),
+                project=self.project.to_model(),
                 description=self.description,
                 configuration=json.loads(
                     base64.b64decode(self.configuration).decode()