Usage

Main code for interacting with APICURON.

class Achievement(**data)[source]

An achievement.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

class Description(**data)[source]

The description.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

submit_remote(*, token=None)[source]

Submit this description on the APICURON site.

Return type

Response

update_remote(*, token=None)[source]

Update this description on the APICURON site.

Return type

Response

RESUBMISSION_URL = 'https://apicuron.org/api/resubmit_activity'

An endpoint for total resubmission

class Report(**data)[source]

A report on a single curation event.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

entity_uri: str

Corresponds to the :Term.activity_term in an entry in Description.terms_def list

class Submission(**data)[source]

A full submission.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

update_remote(*, token=None)[source]

Update this resource on the APICURON site.

Return type

Response

class Term(**data)[source]

A term.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

UPDATE_DESCRIPTION_URL = 'https://apicuron.org/api/update_description'

The endpoint for updating the description

get_reports(uri, *, limit=None, token=None)[source]

Get reports.

Return type

Response

resubmit_curations(payload, *, token=None)[source]

Submit curations data.

Return type

Response

submit_description(payload, *, token=None)[source]

Submit resource data.

Return type

Response