Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 2.12 KB

README.md

File metadata and controls

58 lines (40 loc) · 2.12 KB

Doccano API BETA Client

A beta version of a new design for the Doccano client, featuring more Pythonic interaction, as well as thorough testing and documentation.

Currently tested for compatibility against Doccano v1.5.0-1.5.5.

Usage

The client can be instatiated with a base URL referring to the target Doccano instance. Once instantiated, you can login using your Doccano username and password.

from doccano_api_client.beta import DoccanoClient, controllers

client = DoccanoClient("your_instance_url_here")
client.login("my_username", "my_password")

Once the client is instantiated and a session login to Doccano is established, you can access your projects with Python-ized navigation.

project_controllers = client.projects.all()

my_project_name_controller = next(controller for controller in project_controllers if controller.project.name == "My Project Name")

my_example = models.Example(text="This is an example text")
my_project_name_controller.examples.create(my_example)

Info: "Example" is a synonym for "Document", use this to upload new text-records to label.

Running local integration tests

Given that the Doccano project can get updated with API-breaking changes, we introduced the ability to run local integration tests against all the main endpoints. This allows to make sure that our client is still operational with newer Doccano versions.

To run the integration tests:

  • Spin up doccano locally by cloning the Doccano repo, and deploy or stand up your Doccano instance
  • Then swith to the root of this client repo
pipenv install
pipenv install --dev
  • Adjust the credentials in ""./doccano_api_client/beta/tests/test_full_integration_tests.py"
    • DOCCANO_ENDPOINT = "http://localhost:8000" # TODO: Make this a pytest parameter
    • DOCCANO_USER = "admin"
    • DOCCANO_PASS = "password"
  • Swith to the root of the beta client eg. ./doccano_api_client/beta/
pipenv run test --runintegrationtest

Potential Additions

  • Upgrade to 1.6.x compatibility
  • Potentially adding Pydantic for tighter field validation
  • Add missing functionality that the primary Doccano client offers