transkribus-rest-api

Name	transkribus-rest-api JSON
Version	0.4.1 JSON
	download
home_page	None
Summary	Transkribus Metagrapho API Client.
upload_time	2025-01-06 09:01:07
maintainer	None
docs_url	None
author	None
requires_python	>=3.10
license	GPLv3+
keywords	transkribus api
VCS
bugtrack_url
requirements	requests lxml
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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/38/6f/0cf14f994f5311f52086b876a97056cf8553918e72f912d5f44886f0c633/transkribus_rest_api-0.4.1.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.1",
    "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": "6f8c9c786497a6cade5ca00d57829c0a7ab1bf9bca7892e4cd2642a0fff838fe",
                "md5": "92fc9badaa25df019754e114bb3cadfb",
                "sha256": "0bd4b85d4bdeeb35e9bf53be74d0a146dcc609405c18d8f737c0e59a53d7173d"
            },
            "downloads": -1,
            "filename": "transkribus_rest_api-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "92fc9badaa25df019754e114bb3cadfb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 21324,
            "upload_time": "2025-01-06T09:01:05",
            "upload_time_iso_8601": "2025-01-06T09:01:05.758678Z",
            "url": "https://files.pythonhosted.org/packages/6f/8c/9c786497a6cade5ca00d57829c0a7ab1bf9bca7892e4cd2642a0fff838fe/transkribus_rest_api-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "386f0cf14f994f5311f52086b876a97056cf8553918e72f912d5f44886f0c633",
                "md5": "f4e96163e2f6bb02bd747a59283c5528",
                "sha256": "857ea88aec27e64bf82a6470ced3f37e9663ce73f8e5fe73084d6203be3317c2"
            },
            "downloads": -1,
            "filename": "transkribus_rest_api-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f4e96163e2f6bb02bd747a59283c5528",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 19446,
            "upload_time": "2025-01-06T09:01:07",
            "upload_time_iso_8601": "2025-01-06T09:01:07.888876Z",
            "url": "https://files.pythonhosted.org/packages/38/6f/0cf14f994f5311f52086b876a97056cf8553918e72f912d5f44886f0c633/transkribus_rest_api-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-06 09:01:07",
    "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.32.0"
                ]
            ]
        },
        {
            "name": "lxml",
            "specs": [
                [
                    "~=",
                    "5.3.0"
                ]
            ]
        }
    ],
    "lcname": "transkribus-rest-api"
}