dwc/build
peterdesmet 6b1186429f Reference #253 in build script 2020-08-07 21:46:51 +02:00
..
README.md added Python script that generates term_versions.csv 2020-08-06 15:15:22 -05:00
build.py Reference #253 in build script 2020-08-07 21:46:51 +02:00
generate_normative_csv.py added Python script that generates term_versions.csv 2020-08-06 15:15:22 -05:00
requirements.txt Update requirements 2017-12-06 20:29:13 +01:00
terms.tmpl Add explanation about UseWithIRI 2019-10-21 16:37:12 +02:00

README.md

Build script

The build script build.py uses as input:

To create:

  • The quick reference guide as a Markdown file at docs/terms/index.md. The guide is build as Markdown (with a lot of included html) rather than html, so it can incorporated by Jekyll in the Darwin Core website (including a header, footer and table of content).
  • Two simple Darwin Core CSV files in dist/

Run the build script

  1. Install the required libraries (once):

    pip install -r requirements.txt
    
  2. Run the script from the command line:

    python build.py
    

Generating the "normative document"

The script generate_normative_csv.py pulls source data from the rs.tdwg.org GitHub repo. No local files are required.

It outputs the file term_versions.csv, which is used as the input for the build.py script above.