You must first connect to Evidently Cloud (or your local workspace).

​
Create a Project

To create a Project inside a workspace ws and Organization with an org_id:

project = ws.create_project("My test project", org_id="YOUR_ORG_ID")
project.description = "My project description"
project.save()

In self-hosted open-source installation, you do not need to pass the Org ID. To create a Project:

project = ws.create_project("My test project")
project.description = "My project description"
project.save()

​
Connect to a Project

Project ID. You can see the Project ID above the monitoring Dashboard inside your Project.

To connect to an existing Project from Python, use the get_project method.

project = ws.get_project("PROJECT_ID")

​
Working with a Project

​
Save changes

After making any changes to the Project (like editing description or adding monitoring Panels), always use the save() command:

project.save()

​
Browse Projects

You can see all available Projects on the monitoring homepage, or request a list programmatically. To get a list of all Projects in a workspace ws, use:

ws.list_projects()

To find a specific Project by its name, use the search_project method:

ws.search_project("project_name")

​
[DANGER] Delete Project

Deleting a Project deletes all the data inside it.

To delete the Project:

# ws.delete_project("PROJECT ID")

​
Project parameters

Each Project has the following parameters.

ParameterDescriptionExample
name: strProject name.-
id: UUID4 = Field(default_factory=uuid.uuid4)Unique identifier of the Project. Assigned automatically.-
description: Optional[str] = NoneOptional description. Visible when you browse Projects.-
dashboard: DashboardConfigDashboard configuration that describes the composition of the monitoring Panels.See Dashboard Design for details. You don’t need to explicitly pass DashboardConfig if you use the .dashboard.add_panel method.
date_from: Optional[datetime.datetime] = NoneStart DateTime of the monitoring Dashboard. By default it shows data for all available periods.datetime.now() + timedelta(-30)
date_to: Optional[datetime.datetime] = NoneEnd DateTime of the monitoring Dashboard.Works the same as date_from.
OverviewOverview