# Transkribus Processing API Client
[](https://pypi.org/project/transkribus_metagrapho_api/)
Python bindings for the [Transkribus Metagrapho/Processing API](https://www.transkribus.org/metagrapho/documentation).
## Usage
### with ContextManager
```python
from time import sleep
from transkribus_metagrapho_api import transkribus_metagrapho_api
with transkribus_metagrapho_api(USERNAME, PASSWORD) as api:
process_id = api.process(IMAGE_PATH, line_detection=49272, htr_id=51170)
while True:
match api.status(process_id).upper():
case "FINISHED":
print(api.apge(process_id))
break
case "FAILED":
print("FAILED")
break
sleep(10)
```
or
```python
with transkribus_metagrapho_api(USERNAME, PASSWORD) as api:
for image_path, page_xml in zip(IMAGES, api(IMAGES*, line_detection=49272, htr_id=51170)):
with open(
Path(image_path.parent, image_path.name.replace(image_path.suffix, ".xml")),
"w",
encoding="utf8"
) as f:
f.write(page_xml)
```
### from command line
```bash
$ python3 -m transkribus_metagrapho_api --username USERNAME --password PASSWORD --images images/*.tiff
```
Raw data
{
"_id": null,
"home_page": null,
"name": "transkribus-metagrapho-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/77/48/0423d64457892d343ee1b66f57a3210730319602419ff4b63d373ef64ecf/transkribus_metagrapho_api-0.1.5.tar.gz",
"platform": null,
"description": "# Transkribus Processing API Client\n\n\n[](https://pypi.org/project/transkribus_metagrapho_api/)\n\nPython bindings for the [Transkribus Metagrapho/Processing API](https://www.transkribus.org/metagrapho/documentation).\n\n## Usage\n\n### with ContextManager\n\n```python\nfrom time import sleep\nfrom transkribus_metagrapho_api import transkribus_metagrapho_api\n\nwith transkribus_metagrapho_api(USERNAME, PASSWORD) as api:\n process_id = api.process(IMAGE_PATH, line_detection=49272, htr_id=51170)\n while True:\n match api.status(process_id).upper():\n case \"FINISHED\":\n print(api.apge(process_id))\n break\n case \"FAILED\":\n print(\"FAILED\")\n break\n sleep(10)\n```\n\nor\n\n```python\nwith transkribus_metagrapho_api(USERNAME, PASSWORD) as api:\n for image_path, page_xml in zip(IMAGES, api(IMAGES*, line_detection=49272, htr_id=51170)):\n with open(\n Path(image_path.parent, image_path.name.replace(image_path.suffix, \".xml\")),\n \"w\",\n encoding=\"utf8\"\n ) as f:\n f.write(page_xml)\n```\n\n### from command line\n\n```bash\n$ python3 -m transkribus_metagrapho_api --username USERNAME --password PASSWORD --images images/*.tiff\n```\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Transkribus Metagrapho API Client.",
"version": "0.1.5",
"project_urls": {
"Bug Tracker": "http://github.com/jnphilipp/transkribus_metagrapho_api/issues",
"Homepage": "https://github.com/jnphilipp/transkribus_metagrapho_api"
},
"split_keywords": [
"transkribus",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0049d3e173dfbde81803eeb501e78b9e7b732ab92708d1f6df3436deeb75650",
"md5": "73095284d734dd033880dce1026cff57",
"sha256": "e19b245943c8d430f2b297e8e2e9fefdec00b28871f11029a5e7aff3f5e7856b"
},
"downloads": -1,
"filename": "transkribus_metagrapho_api-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "73095284d734dd033880dce1026cff57",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 22616,
"upload_time": "2025-01-06T08:49:14",
"upload_time_iso_8601": "2025-01-06T08:49:14.669001Z",
"url": "https://files.pythonhosted.org/packages/d0/04/9d3e173dfbde81803eeb501e78b9e7b732ab92708d1f6df3436deeb75650/transkribus_metagrapho_api-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "77480423d64457892d343ee1b66f57a3210730319602419ff4b63d373ef64ecf",
"md5": "713e6ba43e912eb821011fafff54bbe3",
"sha256": "f1e62c77ca60ca694f42bc944f0f8ef1fe1aacc0f83eacb1ed900c3f1a5ff646"
},
"downloads": -1,
"filename": "transkribus_metagrapho_api-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "713e6ba43e912eb821011fafff54bbe3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 20678,
"upload_time": "2025-01-06T08:49:16",
"upload_time_iso_8601": "2025-01-06T08:49:16.729786Z",
"url": "https://files.pythonhosted.org/packages/77/48/0423d64457892d343ee1b66f57a3210730319602419ff4b63d373ef64ecf/transkribus_metagrapho_api-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 08:49:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jnphilipp",
"github_project": "transkribus_metagrapho_api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Pillow",
"specs": [
[
"~=",
"11.1.0"
]
]
},
{
"name": "requests",
"specs": [
[
"~=",
"2.32.0"
]
]
}
],
"lcname": "transkribus-metagrapho-api"
}
JSON
