API Documentation
hansken.py is split up in a number of modules listed below.
The most likely entry point for users is hansken.remote.
This facilitates the communication with the Hansken REST API by means of the Connection
object and enabling users to perform operations in the context of a single project or case by means of the
ProjectContext object.
Both of these require to know what authentication method to use.
This information can be added by creating a HanskenAuthBase instance corresponding to
the authentication method used by the Hansken instance a user is connecting to.
See getting started and authentication for help on determining the right type to use.
Remote objects accept either str or Query instances as queries to be executed by Hansken.
hansken.query provides Python objects to construct simple or complicated queries and the Facet
object to specify a statistical summary of a query result.
A SearchResult provides access to individual traces as Trace
objects with easy access to trace properties.
hansken.tool— Command line interactionhansken.connect— Connecting to Hanskenhansken— Global valueshansken.trace— Interact with traces / search resultshansken.query— Constructing Hansken querieshansken.auth— Authenticationhansken.remote— Communication with Hanskenhansken.util— Utilities for internal and external use