Rogii Solo.Client

SoloClient

attribute project	Project of the SoloClient defined by user via set method.
property projects	Get projects of the SoloClient.
method set_project_by_id(project_id)	Set and Get Project by id.
method set_project_by_name(project_name)	Set and Get Project by name.
method set_project(project)	Set and Get Project by Project.

Module Contents

class SoloClient(client_id: str, client_secret: str, papi_domain_name: str = SOLO_PAPI_DEFAULT_DOMAIN_NAME, proxies: rogii_solo.papi.types.ProxyData | None = None)

Main object for retrieving Solo PAPI data

Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

solo_client = SoloClient(client_id=client_id, client_secret=client_secret)

# Get 'Project1' project
project = solo_client.set_project_by_name('Project1')

project: rogii_solo.project.Project | None = None

Project of the SoloClient defined by user via set method.

property projects: rogii_solo.base.ObjectRepository[rogii_solo.project.Project]

Get projects of the SoloClient.

Returns:

ObjectRepository containing Project instances.

Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

# Get client's projects
solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
projects = solo_client.projects
print(projects.to_dict())

set_project_by_id(project_id: str) → rogii_solo.project.Project | None

Set and Get Project by id.

Returns:

Project with the specified id.

Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

# Get 'ProjectID' project
solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_id('ProjectID')
print(project.to_dict())

set_project_by_name(project_name: str) → rogii_solo.project.Project | None

Set and Get Project by name.

Returns:

Project with the specified name.

Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

# Get 'Project1' project
solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')
print(project.to_dict())

set_project(project: rogii_solo.project.Project) → rogii_solo.project.Project | None

Set and Get Project by Project.

Returns:

Project.

Example:

from rogii_solo import SoloClient

client_id = ... # Input your client ID
client_secret = ... # Input your client secret

# Get 'Project1' project
solo_client = SoloClient(client_id=client_id, client_secret=client_secret)
project = solo_client.set_project_by_name('Project1')

# Set project
project = set_project(project)
print(project.to_dict())