first commit

.bumpversion.cfg

@@ -0,0 +1,9 @@
+[bumpversion]
+current_version = 0.0.1
+commit = True
+tag = True
+
+[bumpversion:file:./pyproject.toml]
+[bumpversion:file:./README.md]
+[bumpversion:file:gplugins/__init__.py]
+

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+ - package-ecosystem: "pip"
+ directory: "/" # Location of package manifests
+ schedule:
+ interval: "daily"
+
+ - package-ecosystem: github-actions
+ directory: /
+ schedule:
+ interval: monthly

.github/workflows/pages.yml

@@ -0,0 +1,46 @@
+name: Sphinx docs to gh-pages
+
+on:
+ push:
+ branches:
+ - main
+ workflow_dispatch:
+
+jobs:
+ build-docs:
+ runs-on: ubuntu-latest
+ name: Sphinx docs to gh-pages
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+ cache: "pip"
+ cache-dependency-path: pyproject.toml
+ - name: Installing the library
+ shell: bash -l {0}
+ run: |
+ make dev
+ - name: make docs
+ run: |
+ make docs
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v2
+ with:
+ path: "./docs/_build/html/"
+ deploy-docs:
+ needs: build-docs
+ permissions:
+ pages: write
+ id-token: write
+
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+
+ runs-on: ubuntu-latest
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v2

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release PyPI, installers and docker container
+
+on:
+ push:
+ tags: "v*"
+
+jobs:
+ release_pypi:
+ if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ cache-dependency-path: pyproject.toml
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install setuptools wheel twine
+ - name: Build and publish
+ env:
+ TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+ TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+ run: |
+ make build
+ twine upload dist/*
+

.github/workflows/test_code.yml

@@ -0,0 +1,86 @@
+name: Test pre-commit, code and docs
+
+on:
+ pull_request:
+ push:
+ branches:
+ - main
+
+jobs:
+ pre-commit:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: "3.10"
+ cache: "pip"
+ cache-dependency-path: pyproject.toml
+ - name: Test pre-commit hooks
+ run: |
+ python -m pip install --upgrade pip
+ pip install pre-commit
+ pre-commit run -a 
+ test_code:
+ runs-on: ${{ matrix.os }}
+ strategy:
+ max-parallel: 12
+ matrix:
+ python-version: ["3.10"]
+ os: [ubuntu-latest, windows-latest, macos-latest]
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v4
+ with:
+ python-version: ${{ matrix.python-version }}
+ cache: "pip"
+ cache-dependency-path: pyproject.toml
+ - name: Install dependencies
+ run: |
+ make dev
+ - name: Test with pytest
+ run: pytest
+ test_code_coverage:
+ runs-on: ubuntu-latest
+ needs: [pre-commit]
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+ - name: Install dependencies
+ run: |
+ make dev
+ - name: Test with pytest
+ run: |
+ pytest --cov
+ - name: Upload coverage to Codecov
+ uses: codecov/codecov-action@v3
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
+ fail_ci_if_error: false
+ test_docs:
+ runs-on: ${{ matrix.os }}
+ strategy:
+ max-parallel: 12
+ matrix:
+ python-version: ['3.10']
+ os: [ubuntu-latest]
+
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+ cache: "pip"
+ cache-dependency-path: pyproject.toml
+ - name: Install dependencies
+ run: |
+ make dev
+ - name: Test documentation
+ run: |
+ make docs

.github/workflows/test_code_conda.yml

@@ -0,0 +1,92 @@
+name: Test pre-commit, code and docs
+
+on:
+ pull_request:
+ push:
+ branches:
+ - main
+
+jobs:
+ pre-commit:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: "3.10"
+ cache: "pip"
+ cache-dependency-path: pyproject.toml
+ - name: Test pre-commit hooks
+ run: |
+ python -m pip install --upgrade pip
+ pip install pre-commit
+ pre-commit run -a 
+ test_code:
+ needs: [pre-commit]
+ runs-on: ${{ matrix.os }}
+ strategy:
+ max-parallel: 12
+ matrix:
+ python-version: ["3.10"]
+ os: [ubuntu-latest, windows-latest, macos-latest]
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v4
+ with:
+ python-version: ${{ matrix.python-version }}
+ cache: "pip"
+ cache-dependency-path: pyproject.toml
+ - name: Install dependencies
+ run: |
+ make dev
+ - name: Test with pytest
+ run: pytest
+ test_code_coverage:
+ runs-on: ubuntu-latest
+ needs: [pre-commit]
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+ - name: Install dependencies
+ run: |
+ make dev
+ - name: Test with pytest
+ run: |
+ pytest --cov={{ cookiecutter.package_name }} {{ cookiecutter.package_name }}
+ - name: Upload coverage to Codecov
+ uses: codecov/codecov-action@v3
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
+ fail_ci_if_error: false
+ test_docs:
+ needs: [pre-commit]
+ runs-on: ${{ matrix.os }}
+ strategy:
+ max-parallel: 12
+ matrix:
+ python-version: ['3.10']
+ os: [ubuntu-latest]
+
+ steps:
+ - uses: actions/checkout@v3
+ - uses: conda-incubator/setup-miniconda@v2
+ with:
+ python-version: '3.10'
+ mamba-version: "*"
+ channels: conda-forge,defaults
+ channel-priority: true
+ activate-environment: anaconda-client-env
+ - name: Add conda to system path
+ run: |
+ echo $CONDA/bin >> $GITHUB_PATH
+ - name: Install dependencies
+ run: |
+ make dev
+ - name: Test documentation
+ run: |
+ make docs