7.1.2.1. citrine.citrine module

class citrine.citrine.Citrine(api_key: str | None = None, *, scheme: str | None = None, host: str | None = None, port: str | None = None)

Bases: object

The entry point for interacting with the Citrine Platform.

Parameters:

• api_key (str) – Unique key that allows a user to access the Citrine Platform. Default: environ.get(‘CITRINE_API_KEY’)

• scheme (str) – Networking protocol; usually https. Default: https

• host (str) – Host URL, generally ‘<your_site>.citrine-platform.com’. Default: environ.get(‘CITRINE_API_HOST’)

• port (Optional[str]) – Optional networking port. Default: None

property catalyst: CatalystResource

Return a resource representing Catalyst.

property projects: ProjectCollection

Return a resource representing all visible projects.

property teams: TeamCollection

Returns a resource representing all visible teams.

property users: UserCollection

Return the collection of all users.