Projects

Projects#


A project is a collaborative workspace in the watsonx.data integration platform where users can organize assets such as jobs, flows, and environments.

Projects provide an isolated context for managing and grouping related assets, allowing for better organization, access control, and lifecycle management.

The SDK provides functionality to interact with projects on the watsonx.data integration platform.

This includes operations such as:

  • Retrieving existing projects

  • Creating a project

  • Updating a project

  • Deleting a project

Retrieving Existing Projects#

To list existing projects in the UI, navigate to View all projects.

Listing projects via the UI

Projects can be retrieved using Platform class. You can also further filter and refine the projects returned based on attributes including name and guid.

This property returns a Projects object.

>>> # Returns first project matching given `guid`
>>> project = platform.projects.get(guid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
Project(guid='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', name="ci_cd_project")
>>> # Return a list of all projects that match `name`
>>> projects = platform.projects.get_all(name="ci_cd_project")
[Project(guid='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', name="ci_cd_project"). Project(guid='yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyy', name="ci_cd_project")]

Creating a Project#

In the UI, you can create a new project by clicking New Project + button.

Creating a project via the UI

To create a new Project object using the SDK, use the Platform.create_project() method.

You must specify the name attribute. Additionally, you can provide optional parameters such as description, tags, public and project_type. If you do not pass in a project_type parameter, the SDK will default to wx, effectively creating the project within the watsonx view.

This method returns a Project object.

>>> project = platform.create_project(
...     name="Test Project",
...     description="Test Project Description",
...     tags=["flow_test_project"],
...     public=True,
...     project_type="wx""
... )
Project(guid='xyxyxyxy-xyxy-xyxy-xyxy-xyxyxyxy', name="Test Project")

Updating a Project#

In the UI, you can update a project by clicking on the pencil icon under the Manage tab of the project. Once you have made the necessary changes, click Save to update the project.

Updating a project via the UI

To update a project via the SDK, first make the necessary in-memory changes to your Project object. Next, pass in this object into the Platform.update_project() method.

This method returns an HTTP response indicating the status of the update operation.

>>> project = platform.projects.get(guid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
>>> project.name = "New name"
>>> project.description = "New description."
>>> res = platform.update_project(project)
<Response [200]>

Deleting a Project#

In the UI, you can delete a project by selecting its title from the projects list. To delete a project, click the Delete button in the top bar.

Deleting a project via the UI

To delete a project, you can pass the project instance to Platform.delete_project() method. This method returns an HTTP response indicating the status of the delete operation.

>>> project = platform.projects.get(guid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
>>> res = platform.delete_project(project)
<Response [204]>
Section Contents