CLI & Python API for Onyx

Introduction

This is the documentation for Onyx-client, a program that provides a command-line interface and Python API for interacting with the Onyx database.

Onyx is being developed as part of the CLIMB-TRE project.

Contents

Installation
Learn how to install the client, or build it manually for development.

Accessibility
Learn how to enable/disable colours in the CLI.

Command-line Interface

Getting Started
Get started with filtering data on the command-line with Onyx.

Documentation
Documentation on all command-line functionality.

Python API

OnyxClient
Documentation on the OnyxClient class, used for interacting with Onyx.

OnyxConfig
Documentation on the OnyxConfig class, used to provide credentials to OnyxClient.

OnyxEnv
Documentation on the OnyxEnv class, used as a shortcut to environment variable credentials.

OnyxField
Documentation on the OnyxField class, used to represent fields in an OnyxClient query.

Exceptions
Documentation on the possible exceptions raised by the OnyxClient.