Repository files navigation

A Python module for parsing, analyzing, and manipulating GEDCOM files.

GEDCOM files contain ancestry data. The parser is currently supporting the GEDCOM 5.5 format which is detailedhere.

Documentation can be found here:https://nickreynke.github.io/python-gedcom/gedcom/index.html

For the latest changes please have a look at theCHANGELOG.md file.

The current development process can be tracked in thedevelop branch.

• When you name your scriptgedcom.py, and import thegedcom module from this package, running your script won'twork because Python will try to resolve imports likegedcom.element.individual from within yourgedcom.py butnot from within the module from this package. Rename your file in this case. (#26)

Local development is done usingpyenv andpipenv using Python 3.5.

1. Runpipenv install -d to install normal and dev dependencies
2. Run tests withtox (pipenv run tox in your console)
   • For Python 3.5 runpipenv run tox -e py35 (you need to have Python 3.5 installed)
   • For Python 3.6 runpipenv run tox -e py36 (you need to have Python 3.6 installed)
   • For Python 3.7 runpipenv run tox -e py37 (you need to have Python 3.7 installed)
   • For Python 3.8 runpipenv run tox -e py38 (you need to have Python 3.8 installed)

1. Runpipenv install -d to install normal and dev dependencies
2. Runpipenv run pdoc3 --html -o docs/ gedcom --force to generate docs into thedocs/ directory

To develop docs runpipenv run pdoc3 --http localhost:8000 gedcomto watch files and instantly see changes in your browser underhttp://localhost:8000.

1. Runpipenv install -d to install normal and dev dependencies
2. Runpipenv run python3 setup.py sdist bdist_wheel to generate distribution archives
3. Runpipenv run twine upload --repository-url https://test.pypi.org/legacy/ dist/* to upload the archives to the Test Python Package Index repository

When the package is ready to be published to the real Python Package Indextherepository-url ishttps://upload.pypi.org/legacy/.

pipenv run twine upload --repository-url https://upload.pypi.org/legacy/ dist/*

All of the following will generate a<major>.<minor>.<patch>-dev<build> version:

# Majorpipenv run bumpversion major --message'chore: release {new_version}'# Minorpipenv run bumpversion minor --message'chore: release {new_version}'# Patchpipenv run bumpversion patch --message'chore: release {new_version}'

To bump up the<build> number, run the following:

pipenv run bumpversion build --message'chore: release {new_version}'

To do a final release of the current<major>.<minor>.<patch> part, run the following:

pipenv run bumpversion release --message'chore: release {new_version}'

This module was originally based on a GEDCOM parser written byDaniel Zappala at Brigham Young University (Copyright (C) 2005) whichwas licensed under the GPL v2 and then continued byMad Price Ball in 2012.

The project was taken over byNicklas Reincke in 2018.Together withDamon Brodie a lot of changes were made and the parser was optimized.

Licensed under theGNU General Public License v2

Python GEDCOM Parser
Copyright (C) 2018 Damon Brodie (damon.brodie at gmail.com)
Copyright (C) 2018-2019 Nicklas Reincke (contact at reynke.com)
Copyright (C) 2016 Andreas Oberritter
Copyright (C) 2012 Madeleine Price Ball
Copyright (C) 2005 Daniel Zappala (zappala at cs.byu.edu)
Copyright (C) 2005 Brigham Young University

This program is free software; you can redistribute it and/or modifyit under the terms of the GNU General Public License as published bythe Free Software Foundation; either version 2 of the License, or(at your option) any later version.

This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU General Public License for more details.

You should have received a copy of the GNU General Public License alongwith this program; if not, write to the Free Software Foundation, Inc.,51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.