Pycaprio

PyCaprio is a Python client for the [INCEpTION](https://github.com/inception-project/inception) annotation tool remote API.

This is a bugfix release.

What's Changed
* 🦟 Issue 18: Illegal document name on create_annotation by reckart in https://github.com/inception-project/pycaprio/pull/19
* 🦟 Issue 2: Adjust format constants by reckart in https://github.com/inception-project/pycaprio/pull/3
* ⚙️ Big http client refactor. Add integration tests. by JavierLuna in https://github.com/inception-project/pycaprio/pull/8
* ⚙️ Fix read the docs integration flow by JavierLuna in https://github.com/inception-project/pycaprio/pull/13

New Contributors
* reckart made their first contribution in https://github.com/inception-project/pycaprio/pull/3
* JavierLuna made their first contribution in https://github.com/inception-project/pycaprio/pull/6

**Full Changelog**: https://github.com/inception-project/pycaprio/compare/0.2.1...v0.3.0

Download

You can install the package using

$ pip install -U pycaprio

License and System requirements

PyCaprio is provided as open source software under the MIT License.

PyCaprio requires **Python version 3.8** or higher.

-- The INCEpTION developer team

This release adds CRUD Curation operations.

python

from pycaprio.mappings import InceptionFormat
Get the annotations or a specific document as e.g. binary CAS
file = client.api.annotation(1, 4, 'test-user', curation_format=InceptionFormat.BIN)
The below function then uploads the file with the new status
client.api.create_curation(1, 4, curation_format = InceptionFormat.BIN, content = annotations, document_state = DocumentState.CURATION_IN_PROGRESS)



Changelog

PYCAP 33 : Add CRUD Curation operations
PYCAP 34 : Fix documentation of curations not rendering as it should

This release introduces *sugar syntax* for the `HttpInceptionAdapter`.

It allows the usage of `pycaprio`'s `Project`, `Document` objects into the main api methods:

python
project = pycaprio_client.api.project(1)

documents = pycaprio_client.api.documents(project) It works now!

documents = pycaprio_client.api.documents(project.project_id) Passing the project id still works

for document in documents:
annotations = pycaprio_client.api.annotations(project, document) Document also works!


Changelog

PYCAP 28: Allows pycaprio objects into http adapter methods.

This is a bugfix release.

Changelog

Changes to `InceptionFormat` to include *all* available formats.

Some names are kept for compatibility reasons, but will be removed in the `0.1.0` release.

Now `InceptionFormat.DEFAULT` points to `text`.

New list is the following:

DEFAULT = 'text'

BIN = 'bin'
CONLL2000 = 'conll2000'
CONLL2006 = 'conll2006'
CONLL2009 = 'conll2009'
CONLLCORENLP = 'conllcorenlp'
CONLLU = 'conllu'
CTSV = 'ctsv'
CTSV3 = 'ctsv3'
DKPRO_CORE_TEI = 'dkpro-core-tei'
TEI = 'dkpro-core-tei'
HTML = 'html'
LIF = 'lif'
NIF = 'nif'
PDF = 'pdf'
PERSEUS_2_1 = 'perseus_2.1'
PUBANNOTATION_SECTIONS = 'pubannotation-sections'
TCF = 'tcf'
TEXT = 'text'
TEXTLINES = 'textlines'
TSV = 'tsv'

XMI = 'xmi'

PERSEUS = 'perseus_2.1'
WEBANNO = 'tsv'
JSON = 'json'



Fix 22.

* Fix 11 Bug

* DocumentFormats -> InceptionFormat
* DocumentStatus -> DocumentState
* AnnotationStatus -> AnnotationState
* format -> document_format, annotation_format, project_format