https://github.com/rise-unibas/tropy-utility

A collection of utility tools for Tropy
https://github.com/rise-unibas/tropy-utility

python tropy

Last synced: 5 months ago
JSON representation

A collection of utility tools for Tropy

• Host: GitHub
• URL: https://github.com/rise-unibas/tropy-utility
• Owner: RISE-UNIBAS
• License: cc-by-4.0
• Created: 2023-11-16T20:12:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T13:56:29.000Z (about 2 years ago)
• Last Synced: 2025-09-05T03:57:19.441Z (9 months ago)
• Topics: python, tropy
• Language: Python
• Homepage:
• Size: 10.2 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
# tropy-utility

A collection of utility tools for [Tropy](https://tropy.org/).

## Creator

This software was created by the University of Basel's Research and Infrastructure Support RISE (rise@unibas.ch) in 2023 and 2024.

## File structure and data overview

Note that there are [different versions of this software](https://github.com/RISE-UNIBAS/tropy-utility/releases), see the [changelog](https://github.com/RISE-UNIBAS/tropy-utility/blob/main/CHANGELOG.md) for details.

- Python package in [`/tropy-utility`](https://github.com/RISE-UNIBAS/tropy-utility/tree/main/metagrapho_tropy)

- documentation [here](https://rise-unibas.github.io/tropy-utility/) and in [`/docs`](https://github.com/RISE-UNIBAS/tropy-utility/tree/main/docs)

- sample scripts and data for each tool in [`/samples`](https://github.com/RISE-UNIBAS/tropy-utility/tree/main/samples)

## Tools

The different tools are accessible via the `Client` class.

### selections2images

Use `Client.selections2images` to save selections of images as new images.

- Documentation [here](https://rise-unibas.github.io/tropy-utility/html/index.html#tropy_utility.client.Client.selections2images).

- Sample script [here](https://github.com/RISE-UNIBAS/tropy-utility/tree/main/samples/selections2images).

### items2transkribus

Use `Client.items2transkribus` to create folders for Tropy items that can be ingested into Transkribus as documents.

- Documentation [here](https://rise-unibas.github.io/tropy-utility/html/index.html#tropy_utility.client.Client.items2transkribus).

- Sample script [here](https://github.com/RISE-UNIBAS/tropy-utility/tree/main/samples/items2transkribus).

## To dos

 - [ ] set up Zenodo integration

 - [ ] initial release

## License


This work is licensed under a Creative Commons Attribution 4.0 International License.