Add support for #18 exporting diff files

+ Redo tests using tox
+ Redo docs
+ Apply my cookie cutter template

Author: lrivallain

.editorconfig

@@ -0,0 +1,21 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.github/workflows/python_application.yml

@@ -0,0 +1,66 @@
+name: Python application
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements_dev.txt
+        pip install .
+    - name: Check endpoint
+      run: |
+        which vro-diff
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      max-parallel: 4
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-2016
+          - windows-latest
+        python-version: [3.5, 3.6, 3.7, 3.8]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements_dev.txt
+        pip install tox-gh-actions
+        pip install .
+    - name: Test with tox
+      env:
+        PYTHONIOENCODING: utf-8
+      run: tox
+
+  documentation:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements_dev.txt
+        pip install .
+    - name: Build sphinx documentation
+      run: |
+        make docs

.github/workflows/pythonapp.yml

@@ -1,8 +1,105 @@
+# Byte-compiled / optimized / DLL files
 __pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
 dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
 *.egg-info/
-*.pyc
-.vscode
-build/
-docs/_build/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
 *.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# IDE
+.vscode/

.gitignore

@@ -1,31 +1,29 @@
-sudo: false
-dist: xenial
+# Config file for automatic testing at travis-ci.org
 language: python
 cache: pip
-matrix:
-  allow_failures:
-  - name: Python 3.7 on Windows
-  fast_finish: true
 
-install:
-  - pip install .
+# Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
+install: pip install -U tox-travis
 
-script:
-  - vro-diff --help
-  - vro-diff --legend ./tests/data/package_v1.0.package ./tests/data/package_v1.1.package
-  - vro-diff --test   ./tests/data/package_v1.0.package ./tests/data/package_v1.1.package || if [[ $? -eq 3 ]]; then true; else false; fi
-  - vro-diff ./tests/data/package_v1.0.package ./tests/data/package_v1.1.package -a # ASCII only
-  - vro-diff ./tests/data/package_v1.0.package ./tests/data/package_v1.1.package -b # Uncolorized
+# test script
+script: tox
 
 jobs:
   include:
-  - python: 3.4
   - python: 3.5
+    env: TOXENV=py35
   - python: 3.6
+    env: TOXENV=py36
   - python: 3.7
-    dist: bionic
-  - python: 3.8-dev
-    dist: bionic
+    env: TOXENV=py37
+  - python: 3.8
+    env: TOXENV=py38
+  - python: 3.8
+    env: TOXENV=flake8
+  - python: 3.8
+    env: TOXENV=build
+  - python: 3.8
+    env: TOXENV=readme
   - name: Python 3.x on Windows
     os: windows
     language: bash
@@ -34,6 +32,7 @@ jobs:
     - export PATH="/c/Python:/c/Python/Scripts:$PATH"
     env:
     - PYTHONIOENCODING=utf-8
+    - TOXENV=py38
   - name: Python 3.7 on macOS
     os: osx
     osx_image: xcode10.2
@@ -46,10 +45,11 @@ jobs:
     python: 3.7
     install:
     - pip install Pygments mock sphinx sphinx-rtd-theme recommonmark
-    - pip install -U -r docs/requirements.txt
+    - pip install -U -r requirements_dev.txt
     - pip install .
     script:
-    - cd docs/ && make html
+    - make docs
+    env: TOXENV=py37
   - stage: Release & Deploy
     python: 3.7
     script: true

.travis.yml

@@ -0,0 +1,15 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Ludovic Rivallain <[email protected]>
+
+Contributors
+------------
+
+* Timo Sugliani: @tsugliani
+
+None yet. Why not be the first?