Skip to main content

This is a library for making requests to a EvaluationKIT API.

Project description

Evalkit API Client Library



This is a library for making requests to an EvaluationKit API.


This project is tested with [tox](

Run the tox command to run checks and unit tests:
$ tox

By default, this project's tox runs:

* [flake8](
* [mypy](
* [pytest](

To create test coverage reports:
$ tox -e cov


Deployment to pypi is done with tox:
$ tox -e deploy
Make sure to bump the version in before deploying.


This project has Sphinx documentation at the following url:

The EvaluationKit API documentation is also very useful:


To install, use pip:

pip install evalkit_api_client

Or clone the repo:

git clone
cd canvas-lms-tools/evalkit_api_client
python install


Adding the client as a dependency in your project's `requirements.txt`
file is the intended way to use the client.

#### REPL Example

$ python
>>> from evalkit_api_client.v1_client import EvalKitAPIv1
>>> url = ''
>>> token = 'xxxxxxxxxxxxxxxxxxxTHISxISxNOTxAxREALxTOKENxxxxxxxxxxxxxxxxxxxxx'
>>> api = EvalKitAPIv1(url, token)
>>> projects = api.get_projects().json()
>>> len(projects.json()) # number of projects in sub-account
>>> for p in projects.['resultList']:
... print(p['id'], p['title'])
49400 Test Evaluation A
57600 Test Eval B

#### Script Example

This very simple example requires a few environment variables. The
API URL and token should be something like:

The recommended approach is to use a config file with limited read
permissions instead of environment variables, but bear with me here.

Once installed in your project via pip, use as follows:

from os import environ
from pprint import pprint

from evalkit_api_client.v1_client import EvalKitAPIv1

url = environ.get('EVALKIT_API_URL')
token = environ.get('EVALKIT_API_TOKEN')

api = EvalKitAPIv1(url, token)
projects = api.get_projects()


#### EvalKitAPIv1

This library is meant to be imported into your code. The `EvalKitAPIv1` client
object requires a `api_url` argument and a `api_token` argument. The `api_url`
should likely be defined in a configuration file, and should be the full API
URL without the endpoint, e.g. ``. The `api_token`
should similarly be defined in a config file, and is the token generated for
a given subaccount in EvaluationKit.

Refer to the client interface [documentation](#documentation) for more information.


#### Building Wheels

Building the wheel:

python bdist_wheel

#### Installing Wheels

How to install the client for testing:

pip uninstall evalkit_api_client || echo "Already uninstalled."
pip install --no-index --find-links=dist evalkit_api_client

Alternatively, install by specifying the full or relative path to the `.whl` file:

pip install --no-index /path/to/canvas-lms-tools/evalkit_api_client/dist/evalkit_api_client-<version>-py2.py3-none-any.whl

(You may need to `pip install wheel` first if you are installing from another
project. Consult [stack overflow](
for more help.)

#### Sphinx Docs

Creating the docs:

cd docs
pip install -r requirements.txt
pip install evalkit_api_client
make html
open build/html/index.html

Deploying the docs to GitHub pages:

git checkout master
git pull
git branch -D gh-pages
git checkout -b gh-pages
rm -rf ./*
touch .nojekyll
git checkout master evalkit_api_client/docs/
< build the docs as above >
mv evalkit_api_client/docs/build/html/* ./
rm -rf evalkit_api_client
git add -A
git commit
git push -f origin gh-pages

For more info see the [GitHub Pages documentation](,
the [Sphinx docs](,
or the following [script docs](


This project was originally created with the following "cookiecutter" tool:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

evalkit_api_client-0.0.1a1-py2.py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page