Skip to main content

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

Project description

python-gedcom logo

Latest Version GEDCOM format version 5.5 Python versions 3.5 to 3.9 Licensing

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 detailed here.

Documentation

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

Changelog

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

Common problems

  • When you name your script gedcom.py, and import the gedcom module from this package, running your script won't work because Python will try to resolve imports like gedcom.element.individual from within your gedcom.py but not from within the module from this package. Rename your file in this case. (#26)

Local development

Local development is done using pyenv and pipenv using Python 3.5.

Running tests

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

Generating docs

  1. Run pipenv install -d to install normal and dev dependencies
  2. Run pipenv run pdoc3 --html -o docs/ python_gedcom_2 --force to generate docs into the docs/ directory

To develop docs run pipenv run pdoc3 --http localhost:8000 gedcom to watch files and instantly see changes in your browser under http://localhost:8000.

Uploading a new package to PyPI

  1. Run pipenv install -d to install normal and dev dependencies
  2. Run pipenv run python3 setup.py sdist bdist_wheel to generate distribution archives
  3. Run pipenv 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 Index the repository-url is https://upload.pypi.org/legacy/.

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

History

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

The project was taken over by Nicklas Reincke in 2018. Together with Damon Brodie a lot of changes were made and the parser was optimized.

It has most recently been forked by Pat Swanson in 2021.

License

Licensed under the GNU 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 modify it under the terms of the GNU General Public License as published by the 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 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-gedcom-2-1.7.0.tar.gz (88.2 kB view details)

Uploaded Source

Built Distribution

python_gedcom_2-1.7.0-py2.py3-none-any.whl (49.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file python-gedcom-2-1.7.0.tar.gz.

File metadata

  • Download URL: python-gedcom-2-1.7.0.tar.gz
  • Upload date:
  • Size: 88.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.2

File hashes

Hashes for python-gedcom-2-1.7.0.tar.gz
Algorithm Hash digest
SHA256 22fceb17045b1295b94829cb0461d058af6113aec1765aa0e7f6c9efbdd479fd
MD5 5a5f24f7c027b43061f79a08005fb70a
BLAKE2b-256 2aaf6b51109e9742f142e002812798e7759792be6759f3450119aa8b977d8545

See more details on using hashes here.

File details

Details for the file python_gedcom_2-1.7.0-py2.py3-none-any.whl.

File metadata

  • Download URL: python_gedcom_2-1.7.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 49.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.2

File hashes

Hashes for python_gedcom_2-1.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ee18064be324bdb4beb8fce874c1d85777abbbe7df4f70b39587fe8d2d415af2
MD5 9d9de358716f910e6540e6e9d301cd40
BLAKE2b-256 ab45ee04a7dd9efa69d5c9367cf1356624654c0aa187ae498c3820502a190ec5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page