rhino_health.lib.endpoints.project.project_dataclass#

Module Contents#

Classes#

Project

DataClass representing a Project on the Rhino platform.

class rhino_health.lib.endpoints.project.project_dataclass.Project(**data)#

Bases: Project

DataClass representing a Project on the Rhino platform.

users :List[rhino_health.lib.endpoints.user.user_dataclass.FutureUser]#
uid :str#

The unique ID of the Project

name :str#

The name of the Project

description :str#

The description of the Project

type :str#

The type of the Project

slack_channel :str#

Slack Channel URL for communications for the Project

primary_workgroup_uid :str#

The unique ID of the Project’s Primary Workgroup

collaborating_workgroups_uids :List[str]#

A list of unique IDs of the Project’s collaborating Workgroups

status :Dict#

The status of the Workgroup

collaborating_workgroups(self)#

Get the Collaborating Workgroup DataClass of this Project

Warning

Be careful when calling this for newly created objects. The workgroups associated with the COLLABORATING_WORKGROUP_UIDS must already exist on the platform.

Warning

The result of this function is cached. Be careful calling this function after making changes to the collaborating workgroups

Returns
collaborating_workgroups: List[Workgroup]

A List of DataClasses representing the Collaborating Workgroups of the Project

add_collaborator(self, collaborator_or_uid)#

Adds COLLABORATOR_OR_UID as a collaborator to this project

Warning

This feature is under development and the interface may change

remove_collaborator(self, collaborator_or_uid)#

Removes COLLABORATOR_OR_UID as a collaborator from this project

Warning

This feature is under development and the interface may change