rhino_health#
Entry point to using the Rhino Health Python SDK.
Subpackages#
rhino_health.librhino_health.lib.endpointsrhino_health.lib.endpoints.code_objectrhino_health.lib.endpoints.code_runrhino_health.lib.endpoints.data_schemarhino_health.lib.endpoints.datasetrhino_health.lib.endpoints.federated_datasetrhino_health.lib.endpoints.projectrhino_health.lib.endpoints.sql_queryrhino_health.lib.endpoints.userrhino_health.lib.endpoints.workgroup
rhino_health.lib.metricsrhino_health.lib.metrics.aggregate_metricsrhino_health.lib.metrics.epidemiologyrhino_health.lib.metrics.base_metricrhino_health.lib.metrics.basicrhino_health.lib.metrics.classificationrhino_health.lib.metrics.coxrhino_health.lib.metrics.filter_variablerhino_health.lib.metrics.frocrhino_health.lib.metrics.kaplan_meierrhino_health.lib.metrics.metric_utilsrhino_health.lib.metrics.quantilerhino_health.lib.metrics.roc_aucrhino_health.lib.metrics.statistics_tests
rhino_health.lib.rest_apirhino_health.lib.constantsrhino_health.lib.rhino_session
Package Contents#
Functions#
|
Login to the Rhino platform and get a RhinoSession to interact with the rest of the system. |
- rhino_health.login(username: str | None = None, password: str | None = None, otp_code: str | None = None, rhino_api_url: str = ApiEnvironment.PROD_API_URL, sdk_version: str = SDKVersion.PREVIEW, show_traceback: bool = False, authentication_details: lib.rest_api.rhino_authenticator.AuthenticationDetailType | None = None) lib.rhino_session.RhinoSession#
Login to the Rhino platform and get a RhinoSession to interact with the rest of the system.
- Parameters:
- username: Optional[str]
The email you are logging in with if logging in with username/password. You must login with either username/password or authentication_details
- password: Optional[str]
The password you are logging in with if logging in with username/password You must login with either username/password or authentication_details
- authentication_details: Optional[AuthenticationDetailType]
Dictionary of authentication information you are logging in with if not using username/password. Refer to Examples and See Also section
- otp_code: Optional[str]
If 2FA is enabled for the account, the One Time Password code from your 2FA device
- rhino_api_url: str
Which rhino environent you are working in.
- sdk_version: str
Used internally for future backwards compatibility. Use the default
- show_traceback: bool
Should traceback information be included if an error occurs
- Returns:
- session: RhinoSession
A session object to interact with the cloud API
See also
rhino_health.lib.constants.ApiEnvironmentList of supported environments
rhino_health.lib.rhino_session.RhinoSessionSession object with accessible endpoints
rhino_health.lib.rest_api.rhino_authenticator.AuthenticationDetailTypeAuthentication detail dictionary for login
Examples
>>> import rhino_health >>> my_username = "user@example.com" # Replace me >>> my_password = "Correct horse battery staple" # Replace me (see https://xkcd.com/936/) >>> session = rhino_health.login(username=my_username, password=my_password, otp_code=otp_code) RhinoSession()
>>> import rhino_health >>> session = rhino_health.login(authentication_details={"sso_access_token": "MyAccessToken", "sso_provider": "google", "sso_client": "my_hospital"}) RhinoSession()