Doccano API Client

A simple client wrapper for the doccano API.

• Doccano API Client
  • Installation
  • Usage
  • Completion
  • To-Do
• Doccano API BETA Client

Installation

To install doccano-client, simply run:

pip install doccano-client

Usage

• Object instantiation takes care of session authorization.
• All methods return a requests.models.Response object.

from doccano_api_client import DoccanoClient

# instantiate a client and log in to a Doccano instance
doccano_client = DoccanoClient(
    'http://doccano.example.com',
    'username',
    'password'
)

# get basic information about the authorized user
r_me = doccano_client.get_me()

# print the details from the above query
print(r_me)

# get the label text from project 1, label 3
label_text = doccano_client.get_label_detail(1, 3)['text']

# upload a json file to project 1. If file is in current directory, file_path is omittable
r_json_upload = doccano_client.post_doc_upload(1, 'json', 'file.json', '/path/to/file/without/filename/')

Info: Uploading documents has been reported as broken, but it works with the beta-client (see below)

• #16
• #13
• #50

Completion

This wrapper's methods are based on doccano url paths.

Key:

• ✔️ implemented
• ❌ not implemented
• ⚠️ currently broken or improperly implemented

Endpoint Names:

• ✔️ auth-token
• ✔️ me
• ✔️ user_list
• ✔️ roles
• ✔️ features
• ✔️ project_list
• ✔️ project_detail
• ✔️ statistics
• ✔️ label_list
• ✔️ label_detail
• ❌ label_upload
• ✔️ doc_list
• ✔️ doc_detail
• ✔️ doc_uploader
• ❌ cloud_uploader
• ✔️ approve_labels
• ✔️ annotation_list
• ⚠️ annotation_detail
• ✔️ doc_downloader
• ✔️ rolemapping_list
• ⚠️ rolemapping_detail

To-Do

• investigate more secure alternatives to plaintext login
• improve docstrings

Doccano API BETA Client

We're introducing a newly revamped Doccano API Client that features more Pythonic interaction as well as more testing and documentation. It also adds more regulated compatibility with specific Doccano release versions.

You can find the documentation on usage of the beta client here.