Skip to main content

A cool tool to generate report for HTR repositories

Project description

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

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

# 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é.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

htr-united-metadata-generator-1.0.1.tar.gz (11.7 kB view hashes)

Uploaded Source

Built Distribution

htr_united_metadata_generator-1.0.1-py2.py3-none-any.whl (11.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page