Merge pull request #16 from PSL-Chartes-HTR-Students/correction

Correction

.github/workflows/HTRUC.yml

@@ -0,0 +1,23 @@
+# 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
+
+name: HTRUC
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    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

.github/workflows/chocomufin.yml

@@ -0,0 +1,24 @@
+# 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
+
+name: ChocoMufin
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    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==0.0.4
+    - name: Run ChocoMufin
+      run: |
+        chocomufin generate table.csv ./data/*.xml
+        cat table.csv

.github/workflows/htrvx.yml

@@ -0,0 +1,23 @@
+# 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
+
+name: htrvx
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    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 htrvx
+    - name: Run HTRVX
+      run: |
+        htrvx --verbose --group --format alto --xsd --check-empty ./data/*.xml

.github/workflows/humGenerator.yml

@@ -0,0 +1,32 @@
+# 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
+
+name: HTR United Report
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    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
+    - name: Run Report
+      run: |
+        humGenerator --group ./data/*.xml --github-envs --to-json updated_metrics.json
+        cat envs.txt >> $GITHUB_ENV
+    - name: Automatically update the catalog's volume key
+      run: |
+        htruc update-volumes htr-united.yml updated_metrics.json --inplace
+        git config user.name github-actions
+        git config user.email github-actions@github.com
+        git add htr-united.yml
+        git commit -m "[Automatic] Update of the Catalog" || echo "Nothing to commit"
+        git push || echo "Nothing to push"

CITATION.CFF

@@ -0,0 +1,14 @@
+cff-version: 1.2.0
+message: "If you use this dataset, please cite it as below."
+authors:
+- family-names: 'L’Eveque'
+  given-names: 'Zoé'
+- family-names: 'Ekaterina'
+  given-names: 'Kate'
+- family-names: 'Kasparian'
+  given-names: 'Anahide'
+title: "OCR d'une poésie corse"
+version: 0.0.1
+date-released: 2022-02-14
+url: "https://github.com/PSL-Chartes-HTR-Students/HN2021-Kovalewsky-1893"
+type: data 

README.md

@@ -1,5 +1,23 @@
 # Git-ENC-Kovalewsky-1893
+
 Transcription du chapitre "Du régime des biens chez les Ossètes",
 dans : Kovalewsky M. Coutume contemporaine et loi ancienne : droit coutumier ossétien, éclairé par l'histoire comparée. Paris, 1893 
 Livre numérisé par la BnF disponible à l'adresse : https://gallica.bnf.fr/ark:/12148/bpt6k1182498b/f1.item
-CF Guide_de_contribution
+
+Autrices:
+
+- Zoé L’Eveque
+- Kate Ekaterina
+- Anahide Kasparian
+
+## Guide de contribution
+
+Guide de contribution – projet Maxime Kovalewsky. 
+
+Nous avons décidé de normaliser le nom attribué aux fichiers de façon à produire un ensemble uniforme : nous avons choisi l’appellation « MK_1893_2_numéro de page.format ». Le sigle « MK » fait référence à l’auteur, Maxime Kovalewsky, et la date « 1893 » à l’année de publication de l’ouvrage. Le « 2 » fait référence au numéro du chapitre étudié, et est suivi du numéro de page, ainsi que du format (png, jpeg ou xml). 
+
+En effet, si toutes nos transcriptions se trouvent en format XML Alto, nous avons parfois rencontré des difficultés concernant l’import et l’export dans eScriptorium et hors d’eScriptorium des images : les formats peuvent donc varier de ce point de vue. Nous avons détaillé plus précisément ce point dans notre fichier « Nos_données ».  
+
+Le document « Nos_données » expose la manière dont nous avons traité nos données, depuis leur import sur eScriptorium à partir du site Gallica de la BNF et leur traitement sur le logiciel, jusqu’à leur dépôt sur le repository Github du groupe. Il permet également de donner un aperçu des difficultés rencontrées lors de notre travail par rapport aux données, ainsi que des limites auxquelles nous avons été confrontés. 
+
+Toutes les questions relatives aux normes de transcription ou autre seront donc traitées dans le document « Nos_données ». Le présent document présente quant à lui les étapes générales par lesquelles nous sommes passés dans la construction de l’architecture du repository du groupe.