Skip to content

Commit

Permalink
Fixing everything to have a first release state (#36)
Browse files Browse the repository at this point in the history 
* reporting modifications from fix31 (PR #32)
to a new branch which doesn't have any conflict with main

* updating these files to latest state from eScriptorium

* trying some fix

* adding 160.xml, which I had forgotten

* removing duplicated images from 'other_images' dirs

* slight update on the workflow config:
- chocomufin will generate a chars table
- will update yml file and create badges
- will create a release

* adding licence file

* adding citation file

* fixing Elsa's last name
  • Loading branch information
@alix-tz
alix-tz authored Mar 13, 2024
1 parent d9564c4 commit 075eb7a
Show file tree
Hide file tree
Showing 51 changed files with 5,855 additions and 5,372 deletions.
155 changes: 89 additions & 66 deletions .github/workflows/htr-united-workflow.yml
View file
Original file line number Diff line number Diff line change
@@ -1,74 +1,97 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

# This file has been generated automatically with HTR-United <3 Github Actions form
name: HTR United Workflow

on: [push, pull_request]

'on':
- push
- pull_request
permissions:
contents: write
jobs:
HTRUC: # Tests that the catalog is correctly written
HTRUC:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install htruc
- name: Run HTRUC
run: |
htruc test htr-united.yml
HTRVX: # Test that the data are following the right format
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install htruc
- name: Run HTRUC
run: |
htruc test htr-united.yml
HTR_United_Metadata_Generator:
runs-on: ubuntu-latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install htrvx
- name: Run HTRVX
run: |
htrvx --verbose --group --format alto --segmonto --xsd --check-empty data/**/*.xml
HTR_United_Metadata_Generator:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install htr-united-metadata-generator htruc anybadge
- name: Run Report
run: |
humGenerator --chars -n NFD --parse alto --group ./data/**/*.xml --github-envs --to-json updated_metrics.json
cat envs.txt >> $GITHUB_ENV
- name: Get HTR United Badge Template
if: github.ref == 'refs/heads/main'
uses: andymckay/get-gist-action@master
with:
gistURL: https://gist.github.com/PonteIneptique/7813bb99f234b334fbf9c6c429ec2406
- name: Automatically update the Catalog & the Badges
if: github.ref == 'refs/heads/main'
run: |-
htruc update-volumes htr-united.yml updated_metrics.json --inplace
# Generate badges
mkdir -p badges
anybadge --value=${{ env.HTRUNITED_CHARS }} --file=badges/characters.svg --label=Characters --color=#007ec6 --overwrite --template=${{ steps.get.outputs.file }}
anybadge --value=${{ env.HTRUNITED_REGNS }} --file=badges/regions.svg --label=Regions --color=#007ec6 --overwrite --template=${{ steps.get.outputs.file }}
anybadge --value=${{ env.HTRUNITED_LINES }} --file=badges/lines.svg --label=Lines --color=#007ec6 --overwrite --template=${{ steps.get.outputs.file }}
anybadge --value=${{ env.HTRUNITED_FILES }} --file=badges/files.svg --label="XML Files" --color=#007ec6 --overwrite --template=${{ steps.get.outputs.file }}
git config user.name github-actions
git config user.email [email protected]
git add htr-united.yml ./badges/
git commit -m "[Automatic] Update the Catalog & the Badges" || echo "Nothing to commit"
git push || echo "Nothing to push"
- uses: rymndhng/release-on-push-action@master
if: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' }}
with:
bump_version_scheme: patch
use_github_release_notes: true
ChocoMufin:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install chocomufin
- name: Run ChocoMufin
run: |
chocomufin generate table.csv ./data/**/*.xml
cat table.csv
HTRVX:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install htr-united-metadata-generator htruc anybadge
- name: Run Report
run: |
humGenerator --parse alto --group ./data/**/*.xml --github-envs --to-json updated_metrics.json --chars -n NFD
cat envs.txt >> $GITHUB_ENV
- name: Get HTR United Badge Template
if: github.ref == 'refs/heads/main'
uses: andymckay/get-gist-action@master
with:
gistURL: "https://gist.github.com/PonteIneptique/7813bb99f234b334fbf9c6c429ec2406"
- name: "Automatically update the catalog's volume key on master branch"
if: github.ref == 'refs/heads/main'
run: |
htruc update-volumes htr-united.yml updated_metrics.json --inplace
# Generate badges
mkdir -p badges
anybadge --value=${{ env.HTRUNITED_CHARS }} --file=badges/characters.svg --label=Characters --color=#007ec6 --overwrite --template=${{ steps.get.outputs.file }}
anybadge --value=${{ env.HTRUNITED_REGNS }} --file=badges/regions.svg --label=Regions --color=#007ec6 --overwrite --template=${{ steps.get.outputs.file }}
anybadge --value=${{ env.HTRUNITED_LINES }} --file=badges/lines.svg --label=Lines --color=#007ec6 --overwrite --template=${{ steps.get.outputs.file }}
anybadge --value=${{ env.HTRUNITED_FILES }} --file=badges/files.svg --label="XML Files" --color=#007ec6 --overwrite --template=${{ steps.get.outputs.file }}
git config user.name github-actions
git config user.email [email protected]
git add htr-united.yml ./badges/
git commit -m "[Automatic] Update of the Catalog & Badges" || echo "Nothing to commit"
git push || echo "Nothing to push"
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install htrvx
- name: Run HTRVX
run: |
htrvx --verbose --group --format alto --check-empty --segmonto --xsd ./data/**/*.xml
31 changes: 31 additions & 0 deletions CITATION.cff
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: CREMMA-MSS-18
message: >-
If you use this dataset, please cite it using the metadata
from this file.
type: dataset
authors:
- given-names: Elsa
family-names: Van Kote
- given-names: Margaux
family-names: Faure
- given-names: Jade
family-names: Norindr
- given-names: Thibault
family-names: Clérice
orcid: 'https://orcid.org/0000-0003-1852-9204'
- given-names: Alix
family-names: Chagué
orcid: 'https://orcid.org/0000-0002-0136-4434'
repository-code: 'https://github.com/HTR-United/CREMMA-MSS-18'
keywords:
- Handwritten Text Recognition
- Dataset
- Ground Truth
- French
- Manuscripts
license: CC-BY-4.0
date-released: '2024-03-13'
Loading

0 comments on commit 075eb7a

Please sign in to comment.