Data

Tools

Indexes

Applications

Experiments

Open Source Science

phyaml

A YAML validator for Programming Historian lessons.

https://github.com/rivaquiroga/phyaml

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (4.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

A YAML validator for Programming Historian lessons.

Basic Info
  • Host: GitHub
  • Owner: rivaquiroga
  • License: gpl-3.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 49.8 KB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 1
  • Releases: 0
Created over 4 years ago · Last pushed over 4 years ago
Metadata Files
Readme License Citation

README.md

status

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

Owner

  • Name: Riva Quiroga
  • Login: rivaquiroga
  • Kind: user

PhD Candidate in Linguistics, Programming Historian Editor, RLadies Santiago + RLadies Valparaíso + PyLadies Valparaíso + LatinR

Citation (CITATION.cff) 

abstract: A Python script that validates a Programming Historian lesson file (.md)
    against a YAML schema.
authors:
  - family-names: Quiroga
    given-names: Riva
    orcid: "https://orcid.org/0000-0002-1147-4135"
  - family-names: Vaughan
    given-names: Nicolas
    orcid: "https://orcid.org/0000-0002-2877-0539"
cff-version: 1.2.0
date-released: "2021-11-06"
keywords:
  - Python
  - YAML
  - "Programming Historian"
license: GPL-3.0
licence-url: "https://www.gnu.org/licenses/gpl-3.0.en.html"
message: If you use this software, please cite it using these metadata.
repository-code: "https://github.com/rivaquiroga/phyaml"
title: phimages
version: 0.1

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 1
  • Total pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • rivaquiroga (1)
Pull Request Authors
  • nivaca (4)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

requirements.txt pypi
  • click *
  • yamale *