Initial commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+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
+Code snippet or clear steps to reproduce behaviour.
+
+### Expected behavior
+A clear and concise description of what you expected to happen.
+
+### Screenshots
+If applicable, add screenshots to help explain your problem.
+
+### Version
+ - Version info such as v0.1.5
+
+### Additional context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+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/pull_request_template.md

@@ -0,0 +1,8 @@
+# PR Type
+[Feature | Fix | Documentation | Other() ]
+
+# Short Description
+...
+
+# Tests Added
+...

.github/workflows/code_checks.yml

@@ -0,0 +1,48 @@
+name: code checks
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/code_checks.yml
+      - '**.py'
+      - poetry.lock
+      - pyproject.toml
+      - '**.ipynb'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/code_checks.yml
+      - '**.py'
+      - poetry.lock
+      - pyproject.toml
+      - '**.ipynb'
+
+jobs:
+  run-code-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+      - uses: actions/[email protected]
+        with:
+          python-version: '3.10'
+          cache: 'poetry'
+      - name: Install dependencies and check code
+        run: |
+          poetry env use '3.10'
+          source .venv/bin/activate
+          poetry install --with test --all-extras
+          pre-commit run --all-files
+      - name: pip-audit (gh-action-pip-audit)
+        uses: pypa/[email protected]
+        with:
+          virtual-environment: .venv/

.github/workflows/docs_build.yml

@@ -0,0 +1,47 @@
+name: docs (build)
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/docs_build.yml
+      - '**.py'
+      - '**.ipynb'
+      - '**.js'
+      - '**.html'
+      - poetry.lock
+      - pyproject.toml
+      - '**.rst'
+      - '**.md'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+      - name: Install dependencies, build docs and coverage report
+        run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
+      - uses: actions/[email protected]
+        with:
+          python-version: '3.10'
+          cache: 'poetry'
+      - run: |
+          python3 -m pip install --upgrade pip && python3 -m pip install poetry
+          poetry env use '3.10'
+          source $(poetry env info --path)/bin/activate
+          poetry install --with docs,test
+          cd docs && rm -rf source/reference/api/_autosummary && make html
+          cd .. && coverage run -m pytest -m "not integration_test" && coverage xml && coverage report -m
+      - name: Upload coverage to Codecov
+        uses: Wandalen/[email protected]
+        with:
+          action: codecov/[email protected]
+          with: |
+            token: ${{ secrets.CODECOV_TOKEN }}
+            file: ./coverage.xml
+            name: codecov-umbrella
+            fail_ci_if_error: true
+          attempt_limit: 5
+          attempt_delay: 30000

.github/workflows/docs_deploy.yml

@@ -0,0 +1,57 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/code_checks.yml
+      - .github/workflows/docs_build.yml
+      - .github/workflows/docs_deploy.yml
+      - .github/workflows/integration_tests.yml
+      - '**.py'
+      - '**.ipynb'
+      - '**.html'
+      - '**.js'
+      - poetry.lock
+      - pyproject.toml
+      - '**.rst'
+      - '**.md'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          submodules: 'true'
+      - name: Install dependencies, build docs and coverage report
+        run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
+      - uses: actions/[email protected]
+        with:
+          python-version: '3.10'
+          cache: 'poetry'
+      - run: |
+          python3 -m pip install --upgrade pip && python3 -m pip install poetry
+          poetry env use '3.10'
+          source $(poetry env info --path)/bin/activate
+          poetry install --with docs,test
+          cd docs && rm -rf source/reference/api/_autosummary && make html
+          cd .. && coverage run -m pytest -m "not integration_test" && coverage xml && coverage report -m
+      - name: Upload coverage to Codecov
+        uses: Wandalen/[email protected]
+        with:
+          action: codecov/[email protected]
+          with: |
+            token: ${{ secrets.CODECOV_TOKEN }}
+            file: ./coverage.xml
+            name: codecov-umbrella
+            fail_ci_if_error: true
+          attempt_limit: 5
+          attempt_delay: 30000
+      - name: Deploy to Github pages
+        uses: JamesIves/[email protected]
+        with:
+          branch: github_pages
+          folder: docs/build/html

.github/workflows/integration_tests.yml

@@ -0,0 +1,61 @@
+name: integration tests
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/code_checks.yml
+      - .github/workflows/docs_build.yml
+      - .github/workflows/docs_deploy.yml
+      - .github/workflows/integration_tests.yml
+      - '**.py'
+      - '**.ipynb'
+      - poetry.lock
+      - pyproject.toml
+      - '**.rst'
+      - '**.md'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/code_checks.yml
+      - .github/workflows/docs_build.yml
+      - .github/workflows/docs_deploy.yml
+      - .github/workflows/integration_tests.yml
+      - '**.py'
+      - '**.ipynb'
+      - poetry.lock
+      - pyproject.toml
+      - '**.rst'
+      - '**.md'
+
+jobs:
+  integration-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+      - name: Install poetry
+        run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
+      - uses: actions/[email protected]
+        with:
+          python-version: '3.10'
+      - name: Install dependencies and check code
+        run: |
+          poetry env use '3.10'
+          source $(poetry env info --path)/bin/activate
+          poetry install --with docs,test
+          coverage run -m pytest -m integration_test && coverage xml && coverage report -m
+      - name: Upload coverage to Codecov
+        uses: Wandalen/[email protected]
+        with:
+          action: codecov/[email protected]
+          with: |
+            token: ${{ secrets.CODECOV_TOKEN }}
+            file: ./coverage.xml
+            name: codecov-umbrella
+            fail_ci_if_error: true
+          attempt_limit: 5
+          attempt_delay: 30000

.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: publish package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install apt dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install libcurl4-openssl-dev libssl-dev
+      - uses: actions/[email protected]
+      - name: Install poetry
+        run: python3 -m pip install --upgrade pip && python3 -m pip install poetry
+      - uses: actions/[email protected]
+        with:
+          python-version: '3.10'
+      - name: Build package
+        run: poetry build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}