Metadata-Version: 2.1
Name: htr-united-metadata-generator
Version: 1.0.3
Summary: A cool tool to generate report for HTR repositories
Home-page: https://github.com/htr-united/htr-united-metadata-generator
Author: Thibault Clerice
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
License-File: LICENSE


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

# HUM Generator, the HTR United Metadata Generator
Tool that generates, through github actions, a set of metadata to help document repos.

# Install as github action

If you want to use badge, see [the tutorial](TUTORIAL.md)

In the directory .github/workflows, create a file HumGenerator with the following content

```yaml
# 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
    - name: Run Report
      run: |
        humGenerator --group **/*.xml
```


---

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


