A gedcom parser written in rust 🦀
GEDCOM is a file format for sharing genealogical information like family trees.
rust-gedcom hopes to be fully mostly compliant with the Gedcom 5.5.1 specification.
Later specifications, such as 5.5.2 and 7.0.11, are useful in assessing which tags are worth supporting or not.
This crate comes in two parts. The first is a binary called parse_gedcom, mostly used for testing & development. It prints the GedcomData object and some stats about the GEDCOM file passed into it:
parse_gedcom ./tests/fixtures/sample.ged
# outputs tree data here w/ stats
# ----------------------
# | Gedcom Data Stats: |
# ----------------------
# submissions: 0
# submitters: 1
# individuals: 3
# families: 2
# repositories: 1
# sources: 1
# multimedia: 0
# ----------------------The second is a library containing the parser.
This crate has an optional feature called json that implements Serialize & Deserialize for the gedcom data structure. This allows you to easily integrate with the web.
For more info about serde, check them out!
The feature is not enabled by default. There are zero dependencies if just using the gedcom parsing functionality.
Use the json feature with any version >=0.2.1 by adding the following to your Cargo.toml:
gedcom = { version = "<version>", features = ["json"] }There are still parts of the specification not yet implemented, and the project is subject to change. The way development has been happening is by taking a GEDCOM file, attempting to parse it and acting on whatever errors or omissions occur. In its current state, it is capable of parsing Heiner Eichmann's allged.ged in its entirety.
Here are some notes about parsed data & tags. Page references are to the Gedcom 5.5.1 specification.
Tags for families (FAM), individuals (IND), repositories (REPO), sources (SOUR), and submitters (SUBM) are handled. Many of the most common sub-tags for these are handled though some may not yet be parsed. Mileage may vary.
Licensed under MIT.