maxhbr / spec-parser

automagically process the specification

spec-parser

Automagically process the specification

Sections

• Installation

• Usage

• Internals of spec-parser

• Grammar specification of parser

• Information on Defaults Error checking

Installing dependencies

❯ python3 -m pip install -r requirements.txt

Usage

❯ python main.py -h
usage: spec-parser [-h] [--gen-md] [--gen-refs] [--gen-rdf] [--use-table] [--out-dir OUT_DIR] spec_dir

SPDX specification parser

positional arguments:
  spec_dir           Directory containing specs

optional arguments:
  -h, --help         show this help message and exit
  --gen-md           Dumps markdown
  --gen-refs         Generate References list for Property
  --gen-rdf          Experimental! Generate RDF in turtle and json-ld format, along with the json-ld context
  --use-table        Use markdown-table to display properties in `Class` entity
  --out-dir OUT_DIR  Output Directory for generating markdown

Current Roadmap

• Validating and reporting all possible parsing error (in any) the incoming markdown files.
• Auto generating Pretty markdowns.
• Adding defaults and Generating cross-references.
• Generating RDF in Turtle format.
• Adding Restrictions in RDF.