Skip to content

Projects

Operations on projects. Available on the client as client.projects.

projects.list

async def list() -> list[ProjectResponseDto]

List all projects visible to the authenticated user.

REST operation: GET /sympheny-app/projects

Returns: list of ProjectResponseDto

async with AsyncSympheny(username, password) as client:
    projects = await client.projects.list()

with Sympheny(username, password) as client:
    projects = client.projects.list()

projects.create

async def create(request: ProjectRequestDto) -> ProjectResponseDto

Create a new project. Only V2 projects are supported.

REST operation: POST /sympheny-app/projects

Parameters

Name Type Required Description
request ProjectRequestDto yes Request body.

Returns: ProjectResponseDto

async with AsyncSympheny(username, password) as client:
    project = await client.projects.create(request)

with Sympheny(username, password) as client:
    project = client.projects.create(request)

projects.get

async def get(
    project_guid: str,
    *,
    include_analyses: bool | None = None,
) -> ProjectDetailResponseDto

Get project details.

REST operation: GET /sympheny-app/projects/{guid}

Parameters

Name Type Required Description
project_guid str yes GUID of the project.
include_analyses bool, optional no Also return the project's analyses.

Returns: ProjectDetailResponseDto

async with AsyncSympheny(username, password) as client:
    project = await client.projects.get(project_guid)

with Sympheny(username, password) as client:
    project = client.projects.get(project_guid)

projects.delete

async def delete(project_guid: str) -> ProjectSummaryResponseDto

Delete a project; returns the remaining projects.

REST operation: DELETE /sympheny-app/projects/{guid}

Parameters

Name Type Required Description
project_guid str yes GUID of the project.

Returns: ProjectSummaryResponseDto

async with AsyncSympheny(username, password) as client:
    remaining = await client.projects.delete(project_guid)

with Sympheny(username, password) as client:
    remaining = client.projects.delete(project_guid)