pylibtemplate 0.0.1__tar.gz

pylibtemplate-0.0.1/.coveragerc

@@ -0,0 +1,19 @@
+[paths]
+source =
+    ../pylibtemplate
+    */site-packages/pylibtemplate
+
+[run]
+branch = true
+source =
+    pylibtemplate
+    .
+omit =
+    */pylibtemplate/version.py
+
+[report]
+show_missing = true
+precision = 2
+
+exclude_lines =
+    if __name__ == .__main__.:

pylibtemplate-0.0.1/.github/workflows/measure_code_coverage.yml

@@ -0,0 +1,61 @@
+name: Measure code coverage
+# This workflow measures the code coverage of the unit tests for the most recent
+# version of Python on a virtual machine with the latest Ubuntu operating
+# system. A badge displaying the code coverage percentage is subsequently made
+# for the README located at the root of the repository.
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  build:
+    if: github.event.pull_request.draft == false
+    
+    runs-on: ubuntu-latest
+    env:
+      PY_COLORS: 1
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox
+        
+    - name: Measure code coverage via tox
+      run: python -m tox -e py312,report
+    
+    - name: Set environment variable for badge
+      run: |
+        echo "COV_PERCENT=$(jq .totals.percent_covered tests/coverage.json \
+          | xargs printf "%.0f")" >> $GITHUB_ENV
+    
+    - name: Archive code coverage results
+      uses: actions/upload-artifact@v4
+      with:
+        name: code_coverage_report
+        path: tests/coverage.json
+        if-no-files-found: error
+    
+    - name: Create badge
+      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+      uses: schneegans/dynamic-badges-action@v1.7.0
+      with:
+        auth: ${{ secrets.CODE_COVERAGE_SECRET }}
+        gistID: 7baba2a56d07b59cc49b8323f44416e5
+        filename: pylibtemplate_coverage_badge.json
+        label: Code Coverage
+        message: ${{ env.COV_PERCENT }}%
+        minColorRange: 50
+        maxColorRange: 100
+        valColorRange: ${{ env.COV_PERCENT }}

pylibtemplate-0.0.1/.github/workflows/publish_documentation_website.yml

@@ -0,0 +1,56 @@
+name: Publish documentation website
+# This workflow builds the static documentation site and then deploys it to
+# GitHub pages.
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+  # Allows you to run this workflow manually from the Actions tab.
+  workflow_dispatch:
+
+jobs:
+  build:
+    if: github.event.pull_request.draft == false
+    
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      pages: write
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .[docs]
+        
+    - name: Generate documentation
+      run: |
+        git fetch --tags
+        cd docs
+        python build_docs.py
+        cd ../
+
+    - name: Setup pages
+      uses: actions/configure-pages@v5
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: './pages'
+
+    - name: Deploy to GitHub pages
+      id: deployment
+      uses: actions/deploy-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}

pylibtemplate-0.0.1/.github/workflows/publish_release_to_pypi.yml

@@ -0,0 +1,32 @@
+name: Publish Python Package
+# This workflow publishes the current release to PyPI.
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install setuptools wheel build
+
+    - name: Build wheel
+      run: |
+        python -m build
+    - name: Publish library
+      uses: pypa/gh-action-pypi-publish@release/v1

pylibtemplate-0.0.1/.github/workflows/test_library.yml

@@ -0,0 +1,37 @@
+name: Test library
+# This workflow runs the unit tests for the Python versions 3.9, 3.10, and 3.11.
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  build:
+    if: github.event.pull_request.draft == false
+    
+    runs-on: ubuntu-latest
+    env:
+      PY_COLORS: 1
+    strategy:
+      max-parallel: 5
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      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
+        
+    - name: Measure code coverage via tox
+      run: python -m tox -e py

pylibtemplate-0.0.1/.gitignore

@@ -0,0 +1,28 @@
+# Ignore select directories
+__pycache__/
+.ipynb_checkpoints/
+examples/examples_data/
+tests/pylibtemplate/
+tests/test_data/
+
+# Ignore select files
+pylibtemplate/_version.py
+pylibtemplate/version.py
+tests/.coverage
+tests/coverage.json
+
+# Ignore .pyc files
+*.pyc
+
+# Ignore #*# files
+\#*#
+*.bak
+*~
+
+# Ignore pip install build files.
+build/
+*.egg-info/
+*/_version.py
+
+# Ignore SLURM output files.
+slurm-*.out