Skip to content

doccano/doccano-client

Repository files navigation

doccano client

Codacy Badge Tests

A simple client for the doccano API.

Installation

To install doccano-client, simply run:

pip install doccano-client

Usage

from doccano_client import DoccanoClient

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

# get basic information about the authorized user
user = client.get_profile()

# list all projects
projects = client.list_projects()

Please see the documentation for further details.

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.