# Transkribus Rest API Client
![Tests](https://github.com/jnphilipp/transkribus_rest_api/actions/workflows/tests.yml/badge.svg)
[![pypi Version](https://img.shields.io/pypi/v/transkribus_rest_api.svg?logo=pypi&logoColor=white)](https://pypi.org/project/transkribus_rest_api/)
Python bindings for the [Transkribus REST API](https://readcoop.eu/transkribus/docu/rest-api/).
## Usage
```python
from transkribus_rest_api import transkribus_rest_api
from transkribus_rest_api.types import UploadPage
with transkribus_rest_api(USERNAME, PASSWORD) as api:
api.upload_document(COLLECTION_ID,
"Test title",
pages=[
UploadPage(image=IMAGE_PATH, page_xml=PAGE_XML_PATH, page_nr=1)
UploadPage(image=IMAGE_PATH, page_xml=PAGE_XML_PATH, page_nr=2)
],
```
Raw data
{
"_id": null,
"home_page": null,
"name": "transkribus-rest-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "transkribus, api",
"author": null,
"author_email": "\"J. Nathanael Philipp\" <nathanael@philipp.land>",
"download_url": "https://files.pythonhosted.org/packages/61/b6/7ed97fde5a3bf866664a68ff320198711870086c39cfd44d4960bef122da/transkribus_rest_api-0.4.0.tar.gz",
"platform": null,
"description": "# Transkribus Rest API Client\n\n![Tests](https://github.com/jnphilipp/transkribus_rest_api/actions/workflows/tests.yml/badge.svg)\n[![pypi Version](https://img.shields.io/pypi/v/transkribus_rest_api.svg?logo=pypi&logoColor=white)](https://pypi.org/project/transkribus_rest_api/)\n\nPython bindings for the [Transkribus REST API](https://readcoop.eu/transkribus/docu/rest-api/).\n\n## Usage\n\n```python\nfrom transkribus_rest_api import transkribus_rest_api\nfrom transkribus_rest_api.types import UploadPage\n\nwith transkribus_rest_api(USERNAME, PASSWORD) as api:\n api.upload_document(COLLECTION_ID,\n \"Test title\",\n pages=[\n UploadPage(image=IMAGE_PATH, page_xml=PAGE_XML_PATH, page_nr=1)\n UploadPage(image=IMAGE_PATH, page_xml=PAGE_XML_PATH, page_nr=2)\n ],\n```\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Transkribus Metagrapho API Client.",
"version": "0.4.0",
"project_urls": {
"Bug Tracker": "http://github.com/jnphilipp/transkribus_rest_api/issues",
"Homepage": "https://github.com/jnphilipp/transkribus_rest_api"
},
"split_keywords": [
"transkribus",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3557e35880494af398f101d0dd0002a0bf61a8a0ec2d08883db942065c77ba3",
"md5": "2769ae062a2d2e6b82e7ecd04cc1c677",
"sha256": "7f30b31feb092bbd694ced104290dffef3184397c21d996eeaf4ef8485b905d0"
},
"downloads": -1,
"filename": "transkribus_rest_api-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2769ae062a2d2e6b82e7ecd04cc1c677",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 21116,
"upload_time": "2024-09-16T11:27:27",
"upload_time_iso_8601": "2024-09-16T11:27:27.504062Z",
"url": "https://files.pythonhosted.org/packages/c3/55/7e35880494af398f101d0dd0002a0bf61a8a0ec2d08883db942065c77ba3/transkribus_rest_api-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61b67ed97fde5a3bf866664a68ff320198711870086c39cfd44d4960bef122da",
"md5": "e01aaecd18ed8efbb9853de8be0944ab",
"sha256": "11dd9bac2cc9e612bc47e66432153096513d96868d2e46e57a8b0eb9fc20c6f8"
},
"downloads": -1,
"filename": "transkribus_rest_api-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "e01aaecd18ed8efbb9853de8be0944ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19406,
"upload_time": "2024-09-16T11:27:28",
"upload_time_iso_8601": "2024-09-16T11:27:28.994538Z",
"url": "https://files.pythonhosted.org/packages/61/b6/7ed97fde5a3bf866664a68ff320198711870086c39cfd44d4960bef122da/transkribus_rest_api-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-16 11:27:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jnphilipp",
"github_project": "transkribus_rest_api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"~=",
"2.31.0"
]
]
},
{
"name": "lxml",
"specs": [
[
"~=",
"5.1.0"
]
]
}
],
"lcname": "transkribus-rest-api"
}