# doccano client
[](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) [](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).
Raw data
{
"_id": null,
"home_page": "https://github.com/doccano/doccano-client",
"name": "doccano-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Hironsan",
"author_email": "hiroki.nakayama.py@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/43/91/e62fb0495d1751cb1c9f02b7bc04d5799e16e7d0d24018de24c440f49376/doccano_client-1.2.8.tar.gz",
"platform": null,
"description": "# doccano client\n\n[](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) [](https://github.com/doccano/doccano-client/actions/workflows/ci.yml)\n\nA simple client for the doccano API.\n\n## Installation\n\nTo install `doccano-client`, simply run:\n\n```bash\npip install doccano-client\n```\n\n## Usage\n\n```python\nfrom doccano_client import DoccanoClient\n\n# instantiate a client and log in to a Doccano instance\nclient = DoccanoClient('http://doccano.example.com')\nclient.login(username='username', password='password')\n\n# get basic information about the authorized user\nuser = client.get_profile()\n\n# list all projects\nprojects = client.list_projects()\n```\n\nPlease see the [documentation](https://doccano.github.io/doccano-client/) for further details.\n\n## Doccano API BETA Client\n\nWe'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.\n\nYou can find the documentation on usage of the beta client [here](doccano_client/beta/README.md).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple client for doccano API.",
"version": "1.2.8",
"project_urls": {
"Homepage": "https://github.com/doccano/doccano-client",
"Repository": "https://github.com/doccano/doccano-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "83f12567cfbde04ad5031d81b968c0b455d686759198e27867d1fc7583c9f35d",
"md5": "e5a71ab46dbbc3b2a6963ad019d7ab06",
"sha256": "50518086b14a6554cb678f6fa7c7e7ecced050da6e6d90853e1dbcb2cc575abb"
},
"downloads": -1,
"filename": "doccano_client-1.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5a71ab46dbbc3b2a6963ad019d7ab06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 109022,
"upload_time": "2023-06-13T02:26:36",
"upload_time_iso_8601": "2023-06-13T02:26:36.733859Z",
"url": "https://files.pythonhosted.org/packages/83/f1/2567cfbde04ad5031d81b968c0b455d686759198e27867d1fc7583c9f35d/doccano_client-1.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4391e62fb0495d1751cb1c9f02b7bc04d5799e16e7d0d24018de24c440f49376",
"md5": "d7c4adfdf829dea945e9f862df2dc428",
"sha256": "b08559b4bf3734e8884e6f93980aa5d1fe1fe92aa686ebdb80a834c113e06043"
},
"downloads": -1,
"filename": "doccano_client-1.2.8.tar.gz",
"has_sig": false,
"md5_digest": "d7c4adfdf829dea945e9f862df2dc428",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 58188,
"upload_time": "2023-06-13T02:26:39",
"upload_time_iso_8601": "2023-06-13T02:26:39.243853Z",
"url": "https://files.pythonhosted.org/packages/43/91/e62fb0495d1751cb1c9f02b7bc04d5799e16e7d0d24018de24c440f49376/doccano_client-1.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-13 02:26:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "doccano",
"github_project": "doccano-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "doccano-client"
}
JSON
