https://github.com/doccano/doccano-client

A simple client for doccano API.
https://github.com/doccano/doccano-client

active-learning annotation api-client api-wrapper data-labeling dataset doccano machine-learning natural-language-processing python text-annotation upload-file

Last synced: 9 months ago
JSON representation

A simple client for doccano API.

• Host: GitHub
• URL: https://github.com/doccano/doccano-client
• Owner: doccano
• License: mit
• Created: 2019-11-22T02:56:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-25T14:24:03.000Z (over 1 year ago)
• Last Synced: 2025-03-29T16:06:35.367Z (10 months ago)
• Topics: active-learning, annotation, api-client, api-wrapper, data-labeling, dataset, doccano, machine-learning, natural-language-processing, python, text-annotation, upload-file
• Language: Python
• Homepage: https://doccano.github.io/doccano-client/
• Size: 1.41 MB
• Stars: 84
• Watchers: 9
• Forks: 65
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# doccano client

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/cf90190126b948e09362048b63600b06)](https://www.codacy.com/gh/doccano/doccano-client/dashboard?utm_source=github.com&utm_medium=referral&utm_content=doccano/doccano-client&utm_campaign=Badge_Grade) [![Tests](https://github.com/doccano/doccano-client/actions/workflows/ci.yml/badge.svg)](https://github.com/doccano/doccano-client/actions/workflows/ci.yml)

A simple client for the doccano API.

## Installation

To install `doccano-client`, simply run:

```bash

pip install doccano-client

```

## Usage

```python

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](https://doccano.github.io/doccano-client/) 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](doccano_client/beta/README.md).