Add CI based on tox (github workflows and templates based on oemof.solph)

.coveragerc

@@ -0,0 +1,16 @@
+[paths]
+source = dhnx
+
+[run]
+branch = true
+source =
+    dhnx
+    tests
+parallel = true
+omit = *custom*
+       *test*
+
+[report]
+show_missing = true
+precision = 2
+omit = *migrations*

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS, Debian, Ubunut, Windows10]
+ - Python version [e.g. 3.8]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/general-issue.md

@@ -0,0 +1,10 @@
+---
+name: General issue
+about: General purpose
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+* Describe your pull request as transparent as possible
+  * What functionality does it implement?
+  * Where is it located?
+  * How does the API look?
+  ...
+
+* Related issues?
+
+* Share your knowledge: Insights/Remarks
+
+* Other comments and questions
+
+* [] For new features: Remember the documentation!

.github/workflows/lint.yml

@@ -0,0 +1,39 @@
+name: Falke8
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+    branches:
+      - master
+      - dev
+
+jobs:
+  run-linters:
+    name: Run linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+
+      - name: Install Python dependencies
+        run: pip install flake8
+
+      - name: Run linters
+        uses: samuelmeuli/lint-action@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          # Enable linters
+          flake8: true
+          # Mark the following line true if you want linters to attempt to autocorrect your code
+          auto_fix: false
+          git_name: "Greene Lab Linter"
+          git_email: "csgreene@upenn.edu"

.github/workflows/packaging.yml

@@ -0,0 +1,37 @@
+name: packaging
+
+on:
+  # Make sure packaging process is not broken
+  push:
+    branches: [master, dev]
+  pull_request:
+  # Make a package for release
+  release:
+    types: [published]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.9]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools setuptools_scm twine wheel
+    - name: Create packages
+      run: python setup.py sdist bdist_wheel
+    - name: Run twine check
+      run: twine check dist/*
+    - uses: actions/upload-artifact@v2
+      with:
+        name: tox-gh-actions-dist
+        path: dist

.github/workflows/tox_checks.yml

@@ -0,0 +1,54 @@
+# NB: this name is used in the status badge
+name: tox checks
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+    branches:
+      - master
+      - dev
+  workflow_dispatch:
+  schedule:
+    - cron: "0 5 * * 6"  # 5:00 UTC every Saturday
+
+jobs:
+  lint:
+    name: ${{ matrix.toxenv }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        toxenv:
+          - clean
+          - check
+          - docs
+
+    steps:
+      - name: Git clone
+        uses: actions/checkout@v2
+
+      - name: Set up Python ${{ env.default_python || '3.9' }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: "${{ env.default_python || '3.9' }}"
+
+      - name: Pip cache
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ matrix.toxenv }}-${{ hashFiles('tox.ini', 'setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-${{ matrix.toxenv }}-
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip
+          python -m pip install -U setuptools wheel
+          python -m pip install -U tox
+
+      - name: Run ${{ matrix.toxenv }}
+        run: python -m tox -e ${{ matrix.toxenv }}

.github/workflows/tox_pytests.yml

@@ -0,0 +1,45 @@
+name: tox pytests
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+    branches:
+      - master
+      - dev
+  workflow_dispatch:
+  schedule:
+    - cron: "0 5 * * 6"  # 5:00 UTC every Saturday
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install xmllint
+      run: sudo apt install coinor-cbc
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox tox-gh-actions coverage coveralls
+    - name: Test with tox
+      run: tox
+
+    - name: Check test coverage
+      run: coverage report -m --fail-under=${{ matrix.vcs == 'bzr' && 24 || 25 }}
+
+    - name: Report to coveralls
+      run: coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COVERALLS_SERVICE_NAME: github

.gitignore

@@ -6,6 +6,19 @@
 results/
 _build
 jupyter_notebooks
-*/import_export_plot/data_csv_output/
-*/import_osmnx/data/
-cache/
+dist/
+
+# Unit test / coverage reports
+.coverage
+.tox
+.coverage.*
+.pytest_cache/
+nosetests.xml
+coverage.xml
+htmlcov
+
+# examples
+examples/import_export_plot/data_csv_output/*
+examples/import_osmnx/osm_network/*
+examples/simulation/tree_results/*
+*/cache/*