+ Bases: OnyxClientBase
Class for querying and manipulating data within Onyx.
+ + + + +__init__(config)
+
+¶Initialise a client.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
config |
+
+
+
+ Object that stores information for connecting and authenticating with Onyx. +
+
+ TYPE:
+ |
+
Examples:
+The recommended way to initialise a client (as a context manager): +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ pass # Do something with the client here
+Alternatively, the client can be initialised as follows: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+client = OnyxClient(config)
+# Do something with the client here
+projects()
+
+¶View available projects.
+ + + +| RETURNS | +DESCRIPTION | +
|---|---|
+
+ List[Dict[str, str]]
+
+ |
+
+
+
+ List of projects. + |
+
Examples:
+ + + +fields(project)
+
+¶View fields for a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, Any]
+
+ |
+
+
+
+ Dict of fields. + |
+
Examples:
+import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ fields = client.fields("project")
+>>> fields
+{
+ "version": "0.1.0",
+ "fields": {
+ "climb_id": {
+ "description": "Unique identifier for a project record in Onyx.",
+ "type": "text",
+ "required": True,
+ "actions": [
+ "get",
+ "list",
+ "filter",
+ ],
+ "restrictions": [
+ "Max length: 12",
+ ],
+ },
+ "is_published": {
+ "description": "Indicator for whether a project record has been published.",
+ "type": "bool",
+ "required": False,
+ "actions": [
+ "get",
+ "list",
+ "filter",
+ "add",
+ "change",
+ ],
+ "default": True,
+ },
+ "published_date": {
+ "description": "The date the project record was published in Onyx.",
+ "type": "date (YYYY-MM-DD)",
+ "required": False,
+ "actions": [
+ "get",
+ "list",
+ "filter",
+ ],
+ },
+ "country": {
+ "description": "Country of origin.",
+ "type": "choice",
+ "required": False,
+ "actions": [
+ "get",
+ "list",
+ "filter",
+ "add",
+ "change",
+ ],
+ "values": [
+ "ENG",
+ "WALES",
+ "SCOT",
+ "NI",
+ ],
+ },
+ },
+}
+choices(project, field)
+
+¶View choices for a field.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
field |
+
+
+
+ Choice field on the project. +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ List[str]
+
+ |
+
+
+
+ List of choices for the field. + |
+
Examples:
+ + + +get(project, climb_id=None, fields=None, include=None, exclude=None)
+
+¶Get a record from a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
climb_id |
+
+
+
+ Unique identifier for the record in the project. +
+
+ TYPE:
+ |
+
fields |
+
+
+
+ Series of conditions on fields, used to filter the data. +
+
+ TYPE:
+ |
+
include |
+
+
+
+ Fields to include in the output. +
+
+ TYPE:
+ |
+
exclude |
+
+
+
+ Fields to exclude from the output. +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, Any]
+
+ |
+
+
+
+ Dict containing the record. + |
+
Examples:
+Get a record by CLIMB ID: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ record = client.get("project", "C-1234567890")
+>>> record
+{
+ "climb_id": "C-1234567890",
+ "published_date": "2023-01-01",
+ "field1": "value1",
+ "field2": "value2",
+}
+Get a record by fields that uniquely identify it: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ record = client.get(
+ "project",
+ fields={
+ "field1": "value1",
+ "field2": "value2",
+ },
+ )
+>>> record
+{
+ "climb_id": "C-1234567890",
+ "published_date": "2023-01-01",
+ "field1": "value1",
+ "field2": "value2",
+}
+The include and exclude arguments can be used to control the fields returned:
+
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ record_v1 = client.get(
+ "project",
+ climb_id="C-1234567890",
+ include=["climb_id", "published_date"],
+ )
+ record_v2 = client.get(
+ "project",
+ climb_id="C-1234567890",
+ exclude=["field2"],
+ )
+>>> record_v1
+{
+ "climb_id": "C-1234567890",
+ "published_date": "2023-01-01",
+}
+>>> record_v2
+{
+ "climb_id": "C-1234567890",
+ "published_date": "2023-01-01",
+ "field1": "value1",
+}
+filter(project, fields=None, include=None, exclude=None, summarise=None)
+
+¶Filter records from a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
fields |
+
+
+
+ Series of conditions on fields, used to filter the data. +
+
+ TYPE:
+ |
+
include |
+
+
+
+ Fields to include in the output. +
+
+ TYPE:
+ |
+
exclude |
+
+
+
+ Fields to exclude from the output. +
+
+ TYPE:
+ |
+
summarise |
+
+
+
+ For a given field (or group of fields), return the frequency of each unique value (or unique group of values). +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Generator[Dict[str, Any], Any, None]
+
+ |
+
+
+
+ Generator of records. If a summarise argument is provided, each record will be a dict containing values of the summary fields and a count for the frequency. + |
+
"published_date" : "2023-01-01")."published_date__year" : "2023")."published_date__range" : "2023-01-01, 2023-01-02").Examples:
+Retrieve all records that match a set of field requirements: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ records = list(
+ client.filter(
+ project="project",
+ fields={
+ "field1": "abcd",
+ "published_date__range" : "2023-01-01, 2023-01-02",
+ },
+ )
+ )
+>>> records
+[
+ {
+ "climb_id": "C-1234567890",
+ "published_date": "2023-01-01",
+ "field1": "abcd",
+ "field2": 123,
+ },
+ {
+ "climb_id": "C-1234567891",
+ "published_date": "2023-01-02",
+ "field1": "abcd",
+ "field2": 456,
+ },
+]
+The summarise argument can be used to return the frequency of each unique value for a given field, or the frequency of each unique set of values for a group of fields:
+
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ records_v1 = list(
+ client.filter(
+ project="project",
+ fields={
+ "field1": "abcd",
+ "published_date__range" : "2023-01-01, 2023-01-02",
+ },
+ summarise="published_date",
+ )
+ )
+
+ records_v2 = list(
+ client.filter(
+ project="project",
+ fields={
+ "field1": "abcd",
+ "published_date__range" : "2023-01-01, 2023-01-02",
+ },
+ summarise=["published_date", "field2"],
+ )
+ )
+>>> records_v1
+[
+ {
+ "published_date": "2023-01-01",
+ "count": 1,
+ },
+ {
+ "published_date": "2023-01-02",
+ "count": 1,
+ },
+]
+>>> records_v2
+[
+ {
+ "published_date": "2023-01-01",
+ "field2": 123,
+ "count": 1,
+ },
+ {
+ "published_date": "2023-01-02",
+ "field2": 456,
+ "count": 1,
+ },
+]
+query(project, query=None, include=None, exclude=None, summarise=None)
+
+¶Query records from a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
query |
+
+
+
+ OnyxField object representing the query being made. +
+
+ TYPE:
+ |
+
include |
+
+
+
+ Fields to include in the output. +
+
+ TYPE:
+ |
+
exclude |
+
+
+
+ Fields to exclude from the output. +
+
+ TYPE:
+ |
+
summarise |
+
+
+
+ For a given field (or group of fields), return the frequency of each unique value (or unique group of values). +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Generator[Dict[str, Any], Any, None]
+
+ |
+
+
+
+ Generator of records. If a summarise argument is provided, each record will be a dict containing values of the summary fields and a count for the frequency. + |
+
& (AND), | (OR), ^ (XOR), and ~ (NOT).Examples:
+Retrieve all records that match the query provided by an OnyxField object: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient, OnyxField
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ records = list(
+ client.query(
+ project="project",
+ query=(
+ OnyxField(field1="abcd")
+ & OnyxField(published_date__range=["2023-01-01", "2023-01-02"])
+ ),
+ )
+ )
+to_csv(csv_file, data, delimiter=None)
+
+
+ classmethod
+
+
+¶Write a set of records to a CSV file.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
csv_file |
+
+
+
+ File object for the CSV file being written to. +
+
+ TYPE:
+ |
+
data |
+
+
+
+ The data being written to the CSV file. Must be either a list / generator of dict records. +
+
+ TYPE:
+ |
+
delimiter |
+
+
+
+ CSV delimiter. If not provided, defaults to ',' for CSVs. Set this to '\t' to work with TSV files. +
+
+ TYPE:
+ |
+
Examples:
+import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client, open("/path/to/file.csv") as csv_file:
+ client.to_csv(
+ csv_file=csv_file,
+ data=client.filter(
+ "project",
+ fields={
+ "field1": "value1",
+ "field2": "value2",
+ },
+ )
+identify(project, field, value, site=None)
+
+¶Get the anonymised identifier for a value on a field.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
field |
+
+
+
+ Field on the project. +
+
+ TYPE:
+ |
+
value |
+
+
+
+ Value to identify. +
+
+ TYPE:
+ |
+
site |
+
+
+
+ Site to identify the value on. If not provided, defaults to the user's site. +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, str]
+
+ |
+
+
+
+ Dict containing the project, site, field, value and anonymised identifier. + |
+
Examples:
+ + + +create(project, fields, test=False)
+
+¶Create a record in a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
fields |
+
+
+
+ Object representing the record to be created. +
+
+ TYPE:
+ |
+
test |
+
+
+
+ If True, runs the command as a test. Default: False +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, Any]
+
+ |
+
+
+
+ Dict containing the CLIMB ID of the created record. + |
+
Examples:
+import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ result = client.create(
+ "project",
+ fields={
+ "field1": "value1",
+ "field2": "value2",
+ },
+ )
+update(project, climb_id, fields=None, test=False)
+
+¶Update a record in a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
climb_id |
+
+
+
+ Unique identifier for the record in the project. +
+
+ TYPE:
+ |
+
fields |
+
+
+
+ Object representing the record to be updated. +
+
+ TYPE:
+ |
+
test |
+
+
+
+ If True, runs the command as a test. Default: False +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, Any]
+
+ |
+
+
+
+ Dict containing the CLIMB ID of the updated record. + |
+
Examples:
+import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ result = client.update(
+ project="project",
+ climb_id="C-1234567890",
+ fields={
+ "field1": "value1",
+ "field2": "value2",
+ },
+ )
+delete(project, climb_id)
+
+¶Delete a record in a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
climb_id |
+
+
+
+ Unique identifier for the record in the project. +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, Any]
+
+ |
+
+
+
+ Dict containing the CLIMB ID of the deleted record. + |
+
Examples:
+ + + +csv_create(project, csv_file, fields=None, delimiter=None, multiline=False, test=False)
+
+¶Use a CSV file to create record(s) in a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
csv_file |
+
+
+
+ File object for the CSV file being used for record upload. +
+
+ TYPE:
+ |
+
fields |
+
+
+
+ Additional fields provided for each record being uploaded. Takes precedence over fields in the CSV. +
+
+ TYPE:
+ |
+
delimiter |
+
+
+
+ CSV delimiter. If not provided, defaults to ',' for CSVs. Set this to '\t' to work with TSV files. +
+
+ TYPE:
+ |
+
multiline |
+
+
+
+ If True, allows processing of CSV files with more than one record. Default: False +
+
+ TYPE:
+ |
+
test |
+
+
+
+ If True, runs the command as a test. Default: False +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Union[Dict[str, Any], List[Dict[str, Any]]]
+
+ |
+
+
+
+ Dict containing the CLIMB ID of the created record. If multiline = True, returns a list of dicts containing the CLIMB ID of each created record. + |
+
Examples:
+Create a single record: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client, open("/path/to/file.csv") as csv_file:
+ result = client.csv_create(
+ project="project",
+ csv_file=csv_file,
+ )
+Create multiple records: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client, open("/path/to/file.csv") as csv_file:
+ results = client.csv_create(
+ project="project",
+ csv_file=csv_file,
+ multiline=True,
+ )
+csv_update(project, csv_file, fields=None, delimiter=None, multiline=False, test=False)
+
+¶Use a CSV file to update record(s) in a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
csv_file |
+
+
+
+ File object for the CSV file being used for record upload. +
+
+ TYPE:
+ |
+
fields |
+
+
+
+ Additional fields provided for each record being uploaded. Takes precedence over fields in the CSV. +
+
+ TYPE:
+ |
+
delimiter |
+
+
+
+ CSV delimiter. If not provided, defaults to ',' for CSVs. Set this to '\t' to work with TSV files. +
+
+ TYPE:
+ |
+
multiline |
+
+
+
+ If True, allows processing of CSV files with more than one record. Default: False +
+
+ TYPE:
+ |
+
test |
+
+
+
+ If True, runs the command as a test. Default: False +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Union[Dict[str, Any], List[Dict[str, Any]]]
+
+ |
+
+
+
+ Dict containing the CLIMB ID of the updated record. If multiline = True, returns a list of dicts containing the CLIMB ID of each updated record. + |
+
Examples:
+Update a single record: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client, open("/path/to/file.csv") as csv_file:
+ result = client.csv_update(
+ project="project",
+ csv_file=csv_file,
+ )
+Update multiple records: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client, open("/path/to/file.csv") as csv_file:
+ results = client.csv_update(
+ project="project",
+ csv_file=csv_file,
+ multiline=True,
+ )
+csv_delete(project, csv_file, delimiter=None, multiline=False)
+
+¶Use a CSV file to delete record(s) in a project.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
project |
+
+
+
+ Name of the project. +
+
+ TYPE:
+ |
+
csv_file |
+
+
+
+ File object for the CSV file being used for record upload. +
+
+ TYPE:
+ |
+
delimiter |
+
+
+
+ CSV delimiter. If not provided, defaults to ',' for CSVs. Set this to '\t' to work with TSV files. +
+
+ TYPE:
+ |
+
multiline |
+
+
+
+ If True, allows processing of CSV files with more than one record. Default: False +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Union[Dict[str, Any], List[Dict[str, Any]]]
+
+ |
+
+
+
+ Dict containing the CLIMB ID of the deleted record. If multiline = True, returns a list of dicts containing the CLIMB ID of each deleted record. + |
+
Examples:
+Delete a single record: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client, open("/path/to/file.csv") as csv_file:
+ result = client.csv_delete(
+ project="project",
+ csv_file=csv_file,
+ )
+Delete multiple records: +
import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client, open("/path/to/file.csv") as csv_file:
+ results = client.csv_delete(
+ project="project",
+ csv_file=csv_file,
+ multiline=True,
+ )
+register(domain, first_name, last_name, email, site, password)
+
+
+ classmethod
+
+
+¶Create a new user.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
domain |
+
+
+
+ Name of the domain. +
+
+ TYPE:
+ |
+
first_name |
+
+
+
+ First name of the user. +
+
+ TYPE:
+ |
+
last_name |
+
+
+
+ Last name of the user. +
+
+ TYPE:
+ |
+
email |
+
+
+
+ Email address of the user. +
+
+ TYPE:
+ |
+
site |
+
+
+
+ Name of the site. +
+
+ TYPE:
+ |
+
password |
+
+
+
+ Password for the user. +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, Any]
+
+ |
+
+
+
+ Dict containing the user's information. + |
+
Examples:
+ + + +login()
+
+¶Log in the user.
+ + + +| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, Any]
+
+ |
+
+
+
+ Dict containing the user's authentication token and it's expiry. + |
+
Examples:
+ + + +logout()
+
+¶logoutall()
+
+¶profile()
+
+¶View the user's information.
+ + + +| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, str]
+
+ |
+
+
+
+ Dict containing the user's information. + |
+
Examples:
+ + + +approve(username)
+
+¶Approve another user.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
username |
+
+
+
+ Username of the user to be approved. +
+
+ TYPE:
+ |
+
| RETURNS | +DESCRIPTION | +
|---|---|
+
+ Dict[str, Any]
+
+ |
+
+
+
+ Dict confirming user approval success. + |
+
Examples:
+ + + +waiting()
+
+¶Get users waiting for approval.
+ + + +| RETURNS | +DESCRIPTION | +
|---|---|
+
+ List[Dict[str, Any]]
+
+ |
+
+
+
+ List of users waiting for approval. + |
+
Examples:
+ + + +site_users()
+
+¶Get users within the site of the requesting user.
+ + + +| RETURNS | +DESCRIPTION | +
|---|---|
+
+ List[Dict[str, Any]]
+
+ |
+
+
+
+ List of users within the site of the requesting user. + |
+
Examples:
+ + + +all_users()
+
+¶Get all users.
+ + + +| RETURNS | +DESCRIPTION | +
|---|---|
+
+ List[Dict[str, Any]]
+
+ |
+
+
+
+ List of all users. + |
+
Examples:
+ + + +Class for storing information required to connect/authenticate with Onyx.
+ + + + +__init__(domain, token=None, username=None, password=None)
+
+¶Initialise a config.
+This object stores information required to connect and authenticate with Onyx.
+A domain must be provided, alongside an API token and/or the username + password.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
domain |
+
+
+
+ Domain for connecting to Onyx. +
+
+ TYPE:
+ |
+
token |
+
+
+
+ Token for authenticating with Onyx. +
+
+ TYPE:
+ |
+
username |
+
+
+
+ Username for authenticating with Onyx. +
+
+ TYPE:
+ |
+
password |
+
+
+
+ Password for authenticating with Onyx. +
+
+ TYPE:
+ |
+
Examples:
+Create a config using environment variables for the domain and an API token: +
import os
+from onyx import OnyxConfig, OnyxEnv
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+Or using environment variables for the domain and login credentials: +
+ +Class containing recommended environment variable names for Onyx.
+If environment variables are created with these recommended names, then the attributes of this class can be used to access them.
+These attributes and the recommended environment variable names are: +
OnyxEnv.DOMAIN = "ONYX_DOMAIN"
+OnyxEnv.TOKEN = "ONYX_TOKEN"
+OnyxEnv.USERNAME = "ONYX_USERNAME"
+OnyxEnv.PASSWORD = "ONYX_PASSWORD"
+Examples:
+In the shell, create the following environment variables with your credentials: +
$ export ONYX_DOMAIN="https://onyx.example.domain"
+$ export ONYX_TOKEN="example-onyx-token"
+$ export ONYX_USERNAME="example-onyx-username"
+$ export ONYX_PASSWORD="example-onyx-password"
+Then access them in Python to create an OnyxConfig object: +
import os
+from onyx import OnyxEnv, OnyxConfig
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+ username=os.environ[OnyxEnv.USERNAME],
+ password=os.environ[OnyxEnv.PASSWORD],
+)
+OnyxError
+
+
+¶
+ Bases: Exception
Generic class for all Onyx exceptions.
+ + +OnyxConfigError
+
+
+¶
+ Bases: OnyxError
Config validation error.
+This error occurs due to validation failures when initialising an OnyxConfig object.
Examples:
+domain was not provided.token or valid login credentials (username and password) were provided.OnyxClientError
+
+
+¶
+ Bases: OnyxError
Client validation error.
+This error occurs due to validation failures within an OnyxClient object, and not due to error codes returned by the Onyx API.
Examples:
+OnyxClient methods.climb_id, creating an invalid URL.OnyxClient.csv_create, OnyxClient.csv_update, or OnyxClient.csv_delete.OnyxClient.csv_create, OnyxClient.csv_update, or OnyxClient.csv_delete when multiline = False.OnyxClient.get request using fields returns more than one result.OnyxRequestError because for this particular combination of parameters, an underlying call to the OnyxClient.filter method is made.OnyxClient.get method expects a single record, resulting in the error being raised.OnyxFieldError
+
+
+¶
+ Bases: OnyxError
Field validation error.
+This error occurs due to validation failures within the OnyxField class.
Examples:
+OnyxField instance with a different type.OnyxField.query is somehow incorrect.OnyxConnectionError
+
+
+¶
+ Bases: OnyxError
Onyx connection error.
+This error occurs due to a failure to connect to the Onyx API.
+ +requests.RequestException (excluding requests.HTTPError) being raised.OnyxHTTPError
+
+
+¶
+ Bases: OnyxError
Onyx HTTP error.
+This error occurs due to a request to the Onyx API either failing (code 4xx) or causing a server error (code 5xx).
requests.HTTPError being raised.requests.HTTPError class, instances of this class have a response object containing details of the error.response object, see: https://requests.readthedocs.io/en/latest/api/#requests.ResponseExamples:
+import os
+from onyx import OnyxConfig, OnyxEnv, OnyxClient, OnyxField
+from onyx.exceptions import OnyxHTTPError
+
+config = OnyxConfig(
+ domain=os.environ[OnyxEnv.DOMAIN],
+ token=os.environ[OnyxEnv.TOKEN],
+)
+
+with OnyxClient(config) as client:
+ try:
+ records = list(
+ client.query(
+ project="project",
+ query=(
+ OnyxField(field1="abcd")
+ & OnyxField(published_date__range=["2023-01-01", "2023-01-02"])
+ ),
+ )
+ )
+ except OnyxHTTPError as e:
+ print(e.response.json())
+OnyxRequestError
+
+
+¶
+ Bases: OnyxHTTPError
Onyx request error.
+This error occurs due to a failed request to the Onyx API (code 4xx).
Examples:
+400 Bad Request).401 Unauthorized).403 Forbidden).404 Not Found).405 Method Not Allowed).OnyxServerError
+
+
+¶
+ Bases: OnyxHTTPError
Onyx server error.
+This error occurs due to a request to the Onyx API causing a server error (code 5xx).
Server errors are unintended and should be reported to an admin if encountered.
+Class that represents a single field-value pair for use in Onyx queries.
+ + + + +__init__(**kwargs)
+
+¶Initialise a field.
+ + + +| PARAMETER | +DESCRIPTION | +
|---|---|
**kwargs |
+
+
+
+ Keyword arguments containing a single key-value pair. +
+
+ TYPE:
+ |
+
& (AND), | (OR), ^ (XOR), and ~ (NOT).Examples:
+Create OnyxField objects and combine them using Python bitwise operators: +
from onyx import OnyxField
+
+field1 = OnyxField(field1="value1")
+field2 = OnyxField(field2__contains="value2")
+
+expression = (field1 | field2) & OnyxField(
+ published_date__range=["2023-01-01", "2023-01-02"]
+)
+>>> field1
+<onyx.field.OnyxField object at 0x1028eb850>
+>>> field2
+<onyx.field.OnyxField object at 0x1028eb850>
+>>> expression
+<onyx.field.OnyxField object at 0x103b6fc40>
+>>> field1.query
+{"field1": "value1"}
+>>> field2.query
+{"field2__contains": "value2"}
+>>> expression.query
+{
+ "&": [
+ {"|": [{"field1": "value1"}, {"field2__contains": "value2"}]},
+ {"published_date__range": "2023-01-01,2023-01-02"},
+ ]
+}
+