Skip to main content

Python client for the grand-challenge.org API

Project description

Grand Challenge API Client

https://img.shields.io/pypi/v/gcapi.svg Build Status Code Coverage Status

Python client for the grand-challenge.org API

  • Free software: Apache Software License 2.0

Features

This client library is a handy way to interact with the REST API for grand-challenge.org from python, and provides some convenience methods. Documentation and examples can be found on Grand Challenge.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.5.4 (2022-02-10)

  • Added archive_item to upload_cases which allows adding images to existing archive items

  • Added interface to upload_cases which allow specifying the image type when uploading to archive and archive items. Can only be used in combination with archive or archive_item.

  • Added update_archive_item which allows editing of archive item values

0.5.3 (2021-12-09)

  • Fix redirect from reader_study.ground_truth

0.5.2 (2021-12-09)

  • Fix reader_study.ground_truth

0.5.1 (2021-12-02)

  • Added client.images.download

  • Removed deprecated client.raw_image_upload_session_files

0.5.0 (2021-11-01)

  • Breaking Change Switched the backend from requests to httpx

  • Breaking Change Removed client.get_algorithm(algorithm=...), use client.algorithms.detail(slug=...) instead

  • Added AsyncClient for asynchronous interation with the Grand Challenge API

  • Added option for getting objects by filters in detail view

  • Added optional timeout parameter to client

  • Removed deprecated algorithm argument to upload_cases

  • Added optional answer argument to upload_cases

  • Added archives endpoint

  • Added MASK answertype

  • Added optional follow_redirects argument to Client.__call__

0.4.0 (2021-06-01)

  • Added run_external_job to execute algorithms directly

  • Deprecated the algorithm argument to upload_cases which will be removed in 0.5.0, use run_external_job instead

0.3.5 (2021-03-01)

  • Allow same domain calls

  • Normalize API tokens

0.3.4 (2021-02-03)

  • Fix number answer type support for readerstudy validation

0.3.3 (2021-02-02)

  • Adds support for multiple polygon image answers

0.3.2 (2021-02-01)

  • Adds support for Number answers

0.3.1 (2021-02-01)

  • Adds support for Image answers

  • Allows setting content rather than filename in upload_files

0.3.0 (2020-12-02)

  • Breaking Changes in upload_cases:
    • Renamed kwarg files_to_upload to files

    • algorithm kwarg now takes a slug rather than a title

    • Removed run_external_algorithm, use upload_cases instead

  • Add Multiple 2D bounding box question types to reader studies

0.2.9 (2020-09-29)

  • Add support for ETDRS grid annotation endpoints

0.2.8 (2020-06-05)

  • Skip validation of PATCH requests

0.2.7 (2020-05-16)

  • Fixed reader study detail lookups

0.2.6 (2020-05-15)

  • Note: this release has been yanked from pypi

  • Added support for retina polygon annotation sets and retina single polygon annotations

  • If authentication token is unset, the GRAND_CHALLENGE_AUTHORIZATION will be used as a fallback

0.2.5 (2020-04-24)

  • Allow null answers

0.2.4 (2020-04-03)

  • Added GET request params

0.2.3 (2020-03-26)

  • Added ground truth endpoint for reader studies

0.2.2 (2020-03-24)

  • Added support for uploading to archives and reader studies

0.2.1 (2020-03-23)

  • Added Polygon and Choice question types to reader studies

0.2.0 (2020-02-09)

  • Dropped Python 2.7 and 3.5

  • Added support for Python 3.7 and 3.8

0.1.0 (2019-05-07)

  • First release on PyPI.

Project details


Download files

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

Source Distribution

gcapi-0.5.4.tar.gz (147.3 kB view hashes)

Uploaded Source

Built Distribution

gcapi-0.5.4-py3-none-any.whl (27.0 kB view hashes)

Uploaded 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