Skip to content

Latest commit

 

History

History
74 lines (56 loc) · 2.92 KB

README.md

File metadata and controls

74 lines (56 loc) · 2.92 KB
Raw

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 poetry package on your machine in order to instantiate a virtual environment.

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

poetry install
poetry 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:

You will need to create an environment variable METRIQ_CLIENT_API_KEY to store the Metriq API key. On Linux/Unix operating systems, you can run

export METRIQ_CLIENT_API_KEY=<the key you get from the website>

in your terminal. On Windows, you can similarly add this variable as an environment variable. Once you have created the environment variable, you can verify that the client works as follows:

from metriq_client import MetriqClient
import os

client = MetriqClient(token=str(os.environ["METRIQ_CLIENT_API_KEY"]))
print(client.hello())
>>> {'status': 'API is working', 'message': 'This is the Metriq public REST API.'}

Further usage

Submissions

Many details of submissions can be managed using the client. For example, the following functionalities can be invoked:

  • Adding a submission or any part of one (method, tag, task, etc.) with submission_add and related functions.
  • Deleting a submission with submission_delete.
  • Sorting submissions (by latest, popular, or trending) with submission_get_by_*.
  • Upvoting a submission with submission_upvote.
  • Updating a submission with submission_update.

Platforms

Information on platforms can also be accessed and edited:

  • Platforms can be added with platform_add and updated with platform_update.
  • A list of platforms can be invoked using platform_get.
  • A list of platforms sorted by how many submissions each has using platform_get_submission_count.

Tags

Similarly, with the client, it is possible to get tag information from Metriq. This includes being able to get a list of tag items with tag_get, or a list of their names with tag_get_names.

Tasks

The client can also:

  • Add tasks with task_add.
  • Update tasks with task_update.
  • Get information on tasks with task_get and task_get_*.

Methods

Functions exist for accessing information about methods:

  • Adding a method to Metriq with method_add.
  • Returning infomration about methods with method_get and method_get_*.
  • Updating a method with method_update.

For even more examples of usage, consult metriq-client/examples.