Merge branch 'dev' into main

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,20 @@
+---
+name: Bug Report
+about: Create a bug report to help us improve
+title: "[BUG]: <your title here>"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behaviour.
+
+**Expected behaviour**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here, including any relevant system information and python version.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: "[FEATURE]: <your title here>"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/framework-request.md

@@ -0,0 +1,23 @@
+---
+name: Algorithm Request
+about: Suggest for a new algorithm to be added to this project
+title: "[ALGORITHM]: <algorithm name here>"
+labels: enhancement
+assignees: ''
+
+---
+
+**Which algorithm would you like added to this project**
+- algorithm name
+- link to academic paper
+
+**Why should this algorithm be added?**
+What benefit is there to adding this algorithm?
+
+**Short summary of algorithm**
+What is the core algorithmic idea behind the algorithm in simple terms. Please give a general overview rather than advanced algorithmic concepts.
+
+**Which algorithm does this build upon, if any?**
+
+**Are you willing to submit a PR?**
+Are you willing to work on this implementation and submit a PR?

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,13 @@
+---
+name: Question
+about: Ask a question about this project
+title: "[Q]: <your title here>"
+labels: question
+assignees: ''
+
+---
+
+**Ask Away!**
+
+- Please double-check the [docs](https://ruck.dontpanic.sh) to make sure that your question is not already answered there.
+- Please double-check the issues to make sure that your question has not been answered before.

.github/workflows/python-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will upload a Python Package
+# using Twine when a release is created
+
+name: publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        python3 -m pip install setuptools wheel twine
+
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        python3 setup.py sdist bdist_wheel
+        python3 -m twine upload dist/*

.github/workflows/python-test.yml

@@ -0,0 +1,44 @@
+# This workflow will install Python dependencies,
+# then run tests over a variety of Python versions.
+
+name: test
+
+on:
+  push:
+    branches: [ main, dev ]
+    tags: [ '*' ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest] # [ubuntu-latest, windows-latest, macos-latest]
+        python-version: [3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        python3 -m pip install -r requirements.txt
+        python3 -m pip install -r requirements-test.txt
+
+    - name: Test with pytest
+      run: |
+        python3 -m pytest --cov=ruck tests/
+
+    - uses: codecov/codecov-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        fail_ci_if_error: true
+      # codecov automatically merges all generated files
+      # if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.9