communitysteps / parse-gedcom

A simple GEDCOM parser that focuses on translating GEDCOM structure into JSON.

Home Page:https://tmcw.github.io/parse-gedcom/live/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

parse-gedcom

build status Greenkeeper badge

A simple GEDCOM parser that focuses on translating GEDCOM structure into JSON.

Tested with GEDCOM 5.5 exported from Geni.com.

Usage

node or browserify:

npm install --save parse-gedcom

otherwise:

<script src='https://wzrd.in/standalone/parse-gedcom@latest'></script>

There's also an example using requirebin to demonstrate how you'd use parse-gedcom with browserify.

CLI Usage

parse-gedcom transforms GEDCOM files into JSON with proper nesting of family & child elements.

Input can be from stdin or a file path given as the first argument.

$ parse-gedcom < file.ged > output.json
$ parse-gedcom file.ged > output.json

parse-gedcom-d3 transforms GEDCOM files into JSON ready to be used in a d3 force layout.

$ parse-gedcom-d3 < file.ged > output.json

API

  • .parse(string) -> JSON
  • .d3ize(JSON) -> d3-capable JSON

See Also

  • There are several other GEDCOM parsers in JavaScript. Unfortunately quite a few of them are unfinished, or have antipatterns like tying themselves to fs.readFile, nixing them for browserify usage. The focus of parse-gedcom is squarely on being simple and presenting the structure of GEDCOM files, rather than expanding abbreviations or creating a new model for the object's format.
  • The most mature GEDCOM parsers are in Java, like DallanQ/Gedcom.

About

A simple GEDCOM parser that focuses on translating GEDCOM structure into JSON.

https://tmcw.github.io/parse-gedcom/live/

License:ISC License


Languages

Language:JavaScript 99.9%Language:HTML 0.1%