Metadata-Version: 2.1
Name: python-gedcom
Version: 2.0.0.dev3
Summary: A Python module for parsing, analyzing, and manipulating GEDCOM files.
Home-page: https://github.com/nickreynke/python-gedcom
Author: Nicklas Reincke
Author-email: contact@reynke.com
License: GPLv2
Project-URL: Bug Reports, https://github.com/nickreynke/python-gedcom/issues
Project-URL: Source, https://github.com/nickreynke/python-gedcom
Description: <p align="center">
          <img src="logo.png">
        </p>
        
        <p align="center">
            <a href="https://pypi.org/project/python-gedcom/" target="_blank"><img src="https://img.shields.io/pypi/v/python-gedcom.svg" alt="PyPI"></a>
            <a href="https://github.com/nickreynke/python-gedcom/releases" target="_blank"><img src="https://img.shields.io/github/release/nickreynke/python-gedcom.svg" alt="GitHub release"></a>
            <a href="https://travis-ci.org/nickreynke/python-gedcom" target="_blank"><img src="https://travis-ci.org/nickreynke/python-gedcom.svg?branch=master" alt="Build Status"></a>
            <img src="https://img.shields.io/badge/GEDCOM%20format%20version-5.5-yellowgreen.svg" alt="GEDCOM format version 5.5">
            <img src="https://img.shields.io/badge/Python%20versions-3.5%20to%203.8-yellowgreen.svg" alt="Python versions 3.5 to 3.8">
        </p>
        
        <p align="center">
            A Python module for parsing, analyzing, and manipulating GEDCOM files.
        </p>
        
        <p align="center">
            GEDCOM files contain ancestry data. The parser is currently supporting the GEDCOM 5.5 format which is detailed
            <a href="https://chronoplexsoftware.com/gedcomvalidator/gedcom/gedcom-5.5.pdf" target="_blank">here</a>.
        </p>
        
        ## Documentation
        
        Documentation can be found here: https://nickreynke.github.io/python-gedcom/gedcom/index.html
        
        ## Changelog
        
        For the latest changes please have a look at the [`CHANGELOG.md`](CHANGELOG.md) file.
        
        The current development process can be tracked in the [develop branch](https://github.com/nickreynke/python-gedcom/tree/develop).
        
        ## Local development
        
        Local development is done using [pyenv](https://github.com/pyenv/pyenv) and
        [pipenv](https://github.com/pypa/pipenv) using Python 3.5.
        
        ### Running tests
        
        1. Run `pipenv install -d` to install normal and dev dependencies
        1. Run tests with [tox](https://tox.readthedocs.io/en/latest/index.html) (`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
        1. 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
        1. Run `pipenv run python3 setup.py sdist bdist_wheel` to generate distribution archives
        1. 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/*`
        
        ## Version bumping (releasing)
        
        All of the following will generate a `<major>.<minor>.<patch>-dev<build>` version:
        
        ```bash
        # Major
        pipenv run bumpversion major --message 'chore: release {new_version}'
        
        # Minor
        pipenv run bumpversion minor --message 'chore: release {new_version}'
        
        # Patch
        pipenv run bumpversion patch --message 'chore: release {new_version}'
        ```
        
        To bump up the `<build>` number, run the following:
        
        ```bash
        pipenv run bumpversion build --message 'chore: release {new_version}'
        ```
        
        To do a final release of the current `<major>.<minor>.<patch>` part, run the following:
        
        ```bash
        pipenv run bumpversion release --message 'chore: release {new_version}'
        ```
        
        ## 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](https://github.com/madprime) in 2012.
        
        The project was taken over by [Nicklas Reincke](https://github.com/nickreynke) in 2018.
        Together with [Damon Brodie](https://github.com/nomadyow) a lot of changes were made and the parser was optimized.
        
        ## License
        
        Licensed under the [GNU General Public License v2](http://www.gnu.org/licenses/gpl-2.0.html)
        
        **Python GEDCOM Parser**
        <br>Copyright (C) 2018 Damon Brodie (damon.brodie at gmail.com)
        <br>Copyright (C) 2018-2019 Nicklas Reincke (contact at reynke.com)
        <br>Copyright (C) 2016 Andreas Oberritter
        <br>Copyright (C) 2012 Madeleine Price Ball
        <br>Copyright (C) 2005 Daniel Zappala (zappala at cs.byu.edu)
        <br>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.
        
Keywords: python gedcom parser
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Sociology :: Genealogy
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: dev
