WIP: 2.0.0

.bumpversion.cfg

@@ -0,0 +1,19 @@
+[bumpversion]
+current_version = 2.0.0-dev3
+commit = True
+tag = True
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+)(?P<build>\d+))?
+serialize = 
+	{major}.{minor}.{patch}-{release}{build}
+	{major}.{minor}.{patch}
+
+[bumpversion:file:setup.py]
+
+[bumpversion:part:release]
+optional_value = prod
+first_value = dev
+values = 
+	dev
+	prod
+
+[bumpversion:part:build]

.github/workflows/release.yml

@@ -0,0 +1,64 @@
+name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-18.04
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.5
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.5
+
+    - name: Install pipenv
+      run: >-
+        pip install pipenv
+
+    - name: Install dependencies
+      run: >-
+        pipenv install -d
+
+    - name: Run tests
+      run: >-
+        pipenv run tox -e py35
+
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        pipenv run python setup.py sdist bdist_wheel
+
+    - name: Publish distribution 📦 to Test PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        TWINE_REPOSITORY_URL: https://test.pypi.org/legacy/
+      run: >-
+        pipenv run twine upload dist/*
+
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        TWINE_REPOSITORY_URL: https://upload.pypi.org/legacy/
+      run: >-
+        pipenv run twine upload dist/*
+
+    - name: Generate docs
+      run: >-
+        pipenv run pdoc3 --html -o docs/ gedcom --force
+
+    - name: Publish docs
+      uses: EndBug/add-and-commit@v4
+      with:
+        author_name: ${{ secrets.AUTHOR_NAME }}
+        author_email: ${{ secrets.AUTHOR_EMAIL }}
+        message: "docs: added new documentation"
+        add: "docs/*"
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -114,3 +114,92 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/

.nvmrc

@@ -0,0 +1 @@
+12.16.1

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Python Gedcom Parser: Contribution Guideline
+
+1. Clone the repo
+1. Make your changes
+1. (Write appropriate tests within `tests/`)
+1. Commit using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+1. [Open a pull request](https://github.com/madprime/python-gedcom/compare)
+1. When checks for the PR fail consider making changes so that the checks pass
+
+## About Conventional Commits
+
+Git committing is done using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) with NPM.
+
+Consider installing node packages with [NVM](https://github.com/nvm-sh/nvm) and start committing with `npm run commit`.
+Git hooks installed via [Husky](https://github.com/typicode/husky) will do the rest.
+
+How to install:
+
+1. Use Node version `12.16.1` (or use [NVM](https://github.com/nvm-sh/nvm) and run `nvm use`)
+1. Run `npm install` and then `npm run commit` to commit your changes

MANIFEST.in

@@ -16,5 +16,14 @@ exclude docs
 recursive-exclude docs *
 recursive-exclude gedcom *.md
 
-# Include GEDCOM test files
-include tests/files/*.ged
+# Exclude test files
+recursive-exclude tests *
+
+# Exclude Node related files
+exclude .nvmrc
+exclude commitlint.config.js
+exclude package.json
+exclude package-lock.json
+
+# Exclude bump2version config
+exclude .bumpversion.cfg

Pipfile

@@ -9,6 +9,7 @@ wheel = "*"
 twine = "*"
 tox = "*"
 pdoc3 = "*"
+bump2version = "*"
 
 [packages]