teams¶

Client API for teams in Nexus.

qnexus.client.teams.create( name: str, description: str | None = None, ) → TeamRef[source]¶

Create a team in Nexus.

Examples

>>> import qnexus as qnx
>>> team_ref = qnx.teams.create(name="team-unobtainium", description="Team studying novel materials")

qnexus.client.teams.get( name: str, scope: ScopeFilterEnum = ScopeFilterEnum.USER, ) → TeamRef[source]¶

Get a single team using filters. Throws an exception if the filters do not match exactly one object.

Examples

>>> import qnexus as qnx
>>> team_ref = qnx.teams.get(name="my-team")

qnexus.client.teams.get_all( scope: ScopeFilterEnum = ScopeFilterEnum.USER, ) → DataframableList[TeamRef][source]¶

Get all teams.

Examples

>>> import qnexus as qnx
>>> all_teams = qnx.teams.get_all()
>>> all_teams.df()