Metadata-Version: 2.4
Name: htruc
Version: 1.1.5
Summary: HTRUC, a toolkit for HTR-United cataloging
Home-page: https://github.com/htr-united/htrvc
Author: Thibault Clérice
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.12.0
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: click<9.0.0,>=8.0.1
Requires-Dist: colorama>=0.4.4
Requires-Dist: jsonschema<4,>=3.0.0
Requires-Dist: pandas>=2.0.0
Requires-Dist: requests>=2.26.0
Requires-Dist: PyGithub>=2.0.0
Requires-Dist: matplotlib>=3.7.0
Requires-Dist: cffconvert>=2.0.0
Requires-Dist: numpy>=1.26.0
Requires-Dist: ruamel.yaml>=0.18.0
Provides-Extra: upload
Requires-Dist: twine; extra == "upload"
Requires-Dist: build; extra == "upload"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary


<img src="./img/HTRUC.png" width=300 align=right>

HTRUC
=====

[![Test](https://github.com/HTR-United/HTRUC/actions/workflows/tests.yml/badge.svg)](https://github.com/HTR-United/HTRUC/actions/workflows/tests.yml)


Pronunced `EuchTruc` (*ce truc*), this contains most of the tooling for the catalog records: 
- Parses catalog records
- Test the validity of the catalog according to different schemas
- Builds agglomerated catalog records with optional dataviz
- Retrieve catalog information from all repositories of a user or an organization.

## Install 

Either clone and run `python setup.py install` **or** use the pip version `pip install htruc`

## Use

### Testing a catalog record

Simply run `htruc test YourYamlFile.yml`

### Upgrade a previously existing catalog record

Run `htruc upgrade yourYamlFile.yml`

### Upgrade a previously existing catalog record to the newest schema

Run `htruc upgrade yourYamlFile.yml`

### Upgrade metrics using [HTR-United Metadata Generator (HUMg)](https://github.com/HTR-United/htr-united-metadata-generator)

Run `htruc update-volumes YourYamlFile.yml MetricFileFromHUMG.jons --inplace`

---

Logo by [Alix Chagué](https://alix-tz.github.io).
