https://github.com/htr-united/htruc

HTR-United Catalog tooling (pronunced EuchTruc)
https://github.com/htr-united/htruc

github-actions tool

Last synced: 5 months ago
JSON representation

HTR-United Catalog tooling (pronunced EuchTruc)

• Host: GitHub
• URL: https://github.com/htr-united/htruc
• Owner: HTR-United
• License: mpl-2.0
• Created: 2021-09-23T12:24:18.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-16T21:07:56.000Z (over 1 year ago)
• Last Synced: 2025-09-05T02:46:15.350Z (10 months ago)
• Topics: github-actions, tool
• Language: Python
• Homepage:
• Size: 460 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          


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).