https://github.com/rivaquiroga/phyaml

A YAML validator for Programming Historian lessons.
https://github.com/rivaquiroga/phyaml

Last synced: 18 days ago
JSON representation

A YAML validator for Programming Historian lessons.

• Host: GitHub
• URL: https://github.com/rivaquiroga/phyaml
• Owner: rivaquiroga
• License: gpl-3.0
• Created: 2021-11-06T00:19:26.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-07T17:41:36.000Z (about 3 years ago)
• Last Synced: 2023-03-07T14:39:50.647Z (almost 2 years ago)
• Language: Python
• Homepage:
• Size: 49.8 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
![status](https://img.shields.io/badge/status-WIP-lightgrey)

# phyaml

## A simple YAML validator for Programming Historian lessons.

## USAGE:

```sh

python3 ph-lesson-yaml-validator.py lesson.md

```

The script automatically detects the lesson type (either an original lesson or a translation) and selects the schema file accordingly:

- `original-lesson-schema.yaml`

- `translated-lesson-schema.yaml`

If the user prefers so, they can also specify another schema file with the argument `--schemafile`, followed by the file name, e.g.:

```sh

python3 ph-lesson-yaml-validator.py lesson.md --schemafile anotherschema.yaml

```

That's all.

If you run the script and something is missing, you will see a message similar to this one:

```

abstract: Required field missing

doi: Required field missing

```