Skip to content

Latest commit

 

History

History
103 lines (75 loc) · 4.88 KB

README.md

File metadata and controls

103 lines (75 loc) · 4.88 KB
Raw

PyPI GitHub release Build Status GEDCOM format version 5.5 Python versions 3.5 to 3.8

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://joeyaurel.github.io/python-gedcom/gedcom/index.html

Changelog

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

The current development process can be tracked in the develop branch.

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/ gedcom --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.

License

Licensed under the GNU General Public License v2

Python GEDCOM Parser
Copyright (C) 2024 Joey Aurel (hi at joeyaurel.dev)
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.