GEDCOM Relationship Report

GEDCOM Relationship Report is a Python-based tool that creates relationship reports from a GEDCOM file exported from Gramps.

The project was created to show the relationship and relationship path from a selected proband to the people in the proband's biological family line. Any person in the GEDCOM file can be selected as the proband.

In the English Gramps interface, the proband corresponds to the Home Person.

If more than one person has the same name, the script displays the matching people and lets you select the correct person by ID.

Requirements

• Gramps 5.2 or later
• Python 3.x
• Python packages:
  • pandas
  • openpyxl
• The GEDCOM filter used by this project must be created in Gramps before exporting the GEDCOM file.

Instructions for creating the required GEDCOM filter are available here:

https://myown-project.dk/guides/gramps-tags-filters/gedcom-filter/index.html

The filter excludes a child recorded with a non-birth relationship and the related family branch unless a biological connection also exists. This is necessary because family relationship names would otherwise be incorrect.

Tested platforms

Tested with:

• Gramps 6.0.8 on Windows 11
• Gramps 6.0.8 on Zorin OS 18.1 Core

macOS has not been tested.

Included files

The release package contains:

• LICENSE
• Maren_Iversen.html
• Maren_Iversen.xlsx
• README.md
• relationship.py
• relationship_names.xlsx
• RELEASE_NOTES.txt

The files Maren_Iversen.html and Maren_Iversen.xlsx are example reports created from the included test data.

relationship_names.xlsx contains the relationship names and the corresponding relationship paths used by the script, for example children, parents, siblings, nieces, grandparents, uncles and first cousins.

Before using your own data

You may review the example files:

• Maren_Iversen.html
• Maren_Iversen.xlsx

This makes it possible to see the expected result before using your own family tree.

Export from Gramps

1. Open Gramps and your family tree.
2. Export the family tree as a GEDCOM file.
3. Under Person filter, select the GEDCOM filter created for this project.
4. Select Calculate Preview and verify that significantly fewer people are included.
5. Save the exported file in the same working folder as relationship.py.
6. Close the family tree and Gramps.

The GEDCOM file is only read by the Python script and is not modified.

Run the report

Open the working folder in a terminal and run:

python relationship.py

Enter the full and correct name of the person who should be used as the proband.

If several people have the same name, the script displays the matching people and lets you select the correct person by ID.

The script creates a subfolder named:

relationship-report-output

Three report files are created in this folder:

• HTML
• XLSX
• JSON

The filenames are based on the selected proband.

Output files

HTML

The HTML report contains:

• Name
• Relationship
• Simplified path
• Relationship path
• Generation

The report can be opened locally in a web browser.

Search is available for:

• Name
• Relationship
• Generation

XLSX

The XLSX report contains the same main report columns as the HTML version.

It can be opened in a spreadsheet application, where all columns can be searched and sorted using the application's normal spreadsheet functions.

JSON

The JSON file contains:

• ID
• Name
• Relationship
• SimplifiedPath
• RelationshipPath
• Generation
• Occupation
• Roles
• Path

Roles and Path are reserved for later use and do not currently contain report data.

Limitations

• Only one .ged2 file may be present in the working folder when the script is run.
• Additional GEDCOM files can temporarily be renamed, for example from .ged2 to .ged2.bak.
• A proband cannot be selected by ID alone. Enter the person's full name first.
• The HTML, XLSX and JSON files are named after the selected proband.
• Running the report again for a proband with the same name overwrites the previous files for that name.
• A GEDCOM file containing about 2,100 people typically takes approximately 1–2 seconds to process, depending on the computer.

Support

For questions and troubleshooting, see:

https://myown-project.dk/support/index.html