Merge pull request #63 from oemof/dev

Release v0.2.0

.coveragerc

@@ -1,4 +1,14 @@
+[paths]
+source = src
+
 [run]
-omit = tests/*
-       *example.py
-source = demandlib
+branch = true
+source =
+    src
+    tests
+parallel = true
+
+[report]
+show_missing = true
+precision = 2
+omit = *migrations*

.editorconfig

@@ -0,0 +1,20 @@
+# see https://editorconfig.org/
+root = true
+
+[*]
+# Use Unix-style newlines for most files (except Windows files, see below).
+end_of_line = lf
+trim_trailing_whitespace = true
+indent_style = space
+insert_final_newline = true
+indent_size = 4
+charset = utf-8
+
+[*.{bat,cmd,ps1}]
+end_of_line = crlf
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[*.tsv]
+indent_style = tab

.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, Ubuntu, Windows10]
+ - Python version [e.g. 3.11]
+
+**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,38 @@
+name: Black
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+
+
+jobs:
+  run-linters:
+    name: Run linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install Python dependencies
+        run: pip install black flake8
+
+      - name: Run linters
+        uses: wearerequired/lint-action@v2
+        with:
+          github_token: ${{ secrets.github_token }}
+          # Enable linters
+          black: true
+          flake8: false
+          # 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: "[email protected]"

.github/workflows/packaging.yml

@@ -0,0 +1,38 @@
+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.11]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e .[build]
+    - name: Create packages
+      run: python -m build .
+    - name: Run twine check
+      run: twine check dist/*
+    - uses: actions/upload-artifact@v4
+      with:
+        name: tox-gh-actions-dist
+        path: dist

.github/workflows/tox_checks.yml

@@ -0,0 +1,51 @@
+# NB: this name is used in the status badge
+name: tox checks
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+
+  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.11' }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ env.default_python || '3.11' }}"
+
+      - name: Pip cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ matrix.toxenv }}-${{ hashFiles('tox.ini', 'pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-${{ matrix.toxenv }}-
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install pip --upgrade
+          python -m pip install tox
+
+      - name: Run ${{ matrix.toxenv }}
+        run: python -m tox -e ${{ matrix.toxenv }}

.github/workflows/tox_pytests.yml

@@ -0,0 +1,41 @@
+name: tox pytests
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+  pull_request:
+
+  workflow_dispatch:
+  schedule:
+    - cron: "0 5 * * 6"  # 5:00 UTC every Saturday
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m 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' && 84 || 85 }}
+
+    - name: Report to coveralls
+      run: coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COVERALLS_SERVICE_NAME: github

.gitignore

@@ -1,66 +1,76 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
 *.py[cod]
-*$py.class
+__pycache__
 
 # C extensions
 *.so
 
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-*.egg-info/
-.installed.cfg
+# Packages
 *.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
+*.egg-info
+dist
+build
+eggs
+.eggs
+parts
+bin
+var
+sdist
+wheelhouse
+develop-eggs
+.installed.cfg
+lib
+lib64
+venv*/
+pyvenv*/
+pip-wheel-metadata/
 
 # Installer logs
 pip-log.txt
-pip-delete-this-directory.txt
 
 # Unit test / coverage reports
-htmlcov/
-.tox/
 .coverage
+.tox
 .coverage.*
-.cache
+.pytest_cache/
 nosetests.xml
 coverage.xml
-*,cover
-.hypothesis/
+htmlcov
 
 # Translations
 *.mo
-*.pot
 
-# Django stuff:
-*.log
+# Buildout
+.mr.developer.cfg
+
+# IDE project files
+.project
+.pydevproject
+.idea
+.vscode
+*.iml
+*.komodoproject
 
-# Sphinx documentation
-docs/_build/
-doc/_build/
+# Complexity
+output/*.html
+output/*/index.html
 
-# PyBuilder
-target/
+# Sphinx
+docs/_build
 
-#Ipython Notebook
-.ipynb_checkpoints
+.DS_Store
+*~
+.*.sw[po]
+.build
+.ve
+.env
+.venv/
+.cache
+.pytest
+.benchmarks
+.bootstrap
+.appveyor.token
+*.bak
+venv/
 
-#IDEs
-.idea/
+# Mypy Cache
+.mypy_cache/