quotas¶

Client API for quotas in Nexus.

qnexus.client.quotas.check_quota( name: Literal['compilation', 'simulation', 'jupyterhub', 'database_usage'], ) → bool[source]¶

Check that the current user has available quota.

Examples

>>> import qnexus as qnx
>>> qnx.quotas.check_quota("simulation")
True

qnexus.client.quotas.get( name: Literal['compilation', 'simulation', 'jupyterhub', 'database_usage'], ) → Quota[source]¶

Get specific quota details by name.

Examples

>>> import qnexus as qnx
>>> sim_quota = qnx.quotas.get("simulation")
>>> sim_quota.df()

qnexus.client.quotas.get_all() → DataframableList[Quota][source]¶

Get all quotas, including usage.

Examples

>>> import qnexus as qnx
>>> quotas = qnx.quotas.get_all()
>>> quotas.df()

class qnexus.quotas.Quota( *, name: str, description: str, usage: float, quota: float | str, )[source]¶

A quota in Nexus.