Merge pull request #401 from mathLab/0.2

Version 0.2

Author: ndem0

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1 @@
+Fixes #ISSUE_NUMBER

.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: "Deployer"
+
+on: 
+  push:
+    tags:
+      - "*"
+
+jobs:
+
+  docs: #######################################################################
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install Python dependencies
+      run: python3 -m pip install .[doc]
+
+    - name: Build Documentation
+      run: |
+        make html
+      working-directory: docs/
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        #deploy_key: ${{ secrets.DEPLOY_PRIVATE_KEY }}
+        publish_dir: ./docs/build/html
+        allow_empty_commit: true
+
+  release_github: #############################################################
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ncipollo/release-action@v1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+  pypi: #######################################################################
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install build
+      run: >-
+        python -m pip install build --user
+
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m build --sdist --wheel --outdir dist/ .
+
+    - name: Publish distribution to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/create-release.yml

@@ -1,20 +1,19 @@
-name: Black Formatter
+name: Master Cleaner
 
 on:
   push:
     branches:
       - master
 
 jobs:
-  linter:
+  formatter:
     name: runner / black
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: psf/black@stable
         with:
-          options: "-l 80"
           src: "./pina"
 
       - name: Create Pull Request
@@ -27,4 +26,4 @@ jobs:
             There appear to be some python formatting errors in ${{ github.sha }}. This pull request
             uses the [psf/black](https://github.com/psf/black) formatter to fix these issues.
           base: ${{ github.head_ref }} # Creates pull request onto pull request or commit branch
-          branch: actions/black
+          branch: actions/black

.github/workflows/deployer.yml

@@ -1,4 +1,4 @@
-name: Monthly Automated Tag
+name: "Monthly Tagger"
 
 on:
   schedule:
@@ -30,7 +30,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: test
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.NDEMO_PAT_TOKEN }}
 

.github/workflows/draft-pdf.yml

@@ -0,0 +1,78 @@
+name: "Testing Pull Request"
+
+on:
+  pull_request:
+    branches:
+      - "master"
+      - "dev"
+
+jobs:
+  unittests: #################################################################
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, macos-latest, ubuntu-latest]
+        python-version: [3.8, 3.9, '3.10', '3.11', '3.12']
+        
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install Python dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        python3 -m pip install .[test]
+
+    - name: Test with pytest
+      run: |
+        python3 -m pytest
+
+  linter: ####################################################################
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Run Black formatter (check mode)
+        uses: psf/black@stable
+        with:
+          src: "./pina"
+
+  testdocs: ##################################################################
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install Python dependencies
+      run: python3 -m pip install .[doc]
+
+    - name: Build Documentation
+      run: |
+        make html SPHINXOPTS+='-W'
+      working-directory: docs/
+
+  coverage: ##################################################################
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install .[test]
+        
+      - name: Generate coverage report
+        run: |
+            python3 -m pytest --cov-report term --cov-report xml:cobertura.xml --cov=pina
+
+      - name: Produce the coverage report
+        uses: insightsengineering/coverage-action@v2
+        with:
+          path: ./cobertura.xml
+          threshold: 80.123
+          fail: true
+          publish: true
+          coverage-summary-title: "Code Coverage Summary"