Metriq API client

This is a client for Metriq read/write API.

It is adapted from the PapersWithCode client, with thanks!

The API is completely covered by the client and it wraps all the API models into python objects and communicates with the API by getting and passing those objects from and to the api client.

Quick usage example

You will require the pipenv package on your machine in order to instantiate a virtual environment. This can be done with pip install --user pipenv.

You will then need to install and activate the virtual environment:

pipenv install
pipenv shell

Once the virtual environment has been activated, to check that the metriq-client API is working as expected, run the following example script from metriq-client/examples/metriq_hello.py:

from metriq import MetriqClient

client = MetriqClient(token="[Get this token from your web app account, and replace this string with it.]")
print(client.hello())
>>> {'status': 'API is working', 'message': 'This is the Metriq public REST API.'}

For further examples of usage, consult metriq-client/examples.