Metadata-Version: 2.4
Name: transkribus_rest_api
Version: 0.4.2
Summary: Transkribus Metagrapho API Client.
Author-email: "J. Nathanael Philipp" <nathanael@philipp.land>
License: GPLv3+
Project-URL: Homepage, https://github.com/jnphilipp/transkribus_rest_api
Project-URL: Bug Tracker, http://github.com/jnphilipp/transkribus_rest_api/issues
Keywords: transkribus,api
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests~=2.32.0
Requires-Dist: lxml~=6.0.2
Dynamic: license-file

# 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)
        ],
    )
```
