PQEnalyzer 0.6.2__tar.gz

pqenalyzer-0.6.2/.githooks/commit-msg

@@ -0,0 +1,169 @@
+#!/bin/bash
+
+message=$(cat .git/COMMIT_EDITMSG)
+lowercase_message=${message,,}
+
+# Check for patterns and handle errors
+matched=false
+
+# Features
+if [[ "$lowercase_message" =~ ^feat(\(.+\))?: ]]; then
+  matched=true
+  group="Feature"
+fi
+
+# Bug Fixes
+if [[ "$lowercase_message" =~ ^fix(\(.+\))?: ]]; then
+  matched=true
+  group="Fix"
+fi
+
+if [[ "$lowercase_message" =~ ^docs(\(.+\))?: ]]; then
+  matched=true
+  group="Docs"
+elif [[ "$lowercase_message" =~ ^doc(\(.+\))?: ]]; then
+  matched=true
+  group="Docs"
+fi
+
+if [[ "$lowercase_message" =~ ^style(\(.+\))?: ]]; then
+  matched=true
+  group="Style"
+fi
+
+if [[ "$lowercase_message" =~ ^refactor(\(.+\))?: ]]; then
+  matched=true
+  group="Refactor"
+elif [[ "$lowercase_message" =~ ^ref(\(.+\))?: ]]; then
+  matched=true
+  group="Refactor"
+fi
+
+if [[ "$lowercase_message" =~ ^perf(\(.+\))?: ]]; then
+  matched=true
+  group="Performance"
+fi
+
+if [[ "$lowercase_message" =~ ^test(\(.+\))?: ]]; then
+  matched=true
+  group="Test"
+elif [[ "$lowercase_message" =~ ^tests(\(.+\))?: ]]; then
+  matched=true
+  group="Test"
+fi
+
+#chore
+if [[ "$lowercase_message" =~ ^chore(\(.+\))?: ]]; then
+  matched=true
+  group="Chore"
+fi
+
+#merge
+if [[ "$lowercase_message" =~ ^merge(\(.+\))?: ]]; then
+  matched=true
+  group="Merge"
+fi
+
+# Reverts
+if [[ "$lowercase_message" =~ ^revert(\(.+\))?: ]]; then
+  matched=true
+  group="Revert"
+fi
+
+if [[ "$lowercase_message" =~ ^build(\(.+\))?: ]]; then
+  matched=true
+  group="Breaking"
+fi
+
+# Examples
+if [[ "$lowercase_message" =~ ^example(\(.+\))?: ]]; then
+  matched=true
+  group="Example"
+elif [[ "$lowercase_message" =~ ^examples(\(.+\))?: ]]; then
+  matched=true
+  group="Example"
+fi
+
+# Dependency Updates (informational)
+if [[ "$lowercase_message" =~ ^deps(\(.+\))?: ]]; then
+  matched=true
+  group="Dependency"
+fi
+
+# ci
+if [[ "$lowercase_message" =~ ^ci(\(.+\))?: ]]; then
+  matched=true
+  group="CI"
+fi
+
+#pylint
+if [[ "$lowercase_message" =~ ^pylint(\(.+\))?: ]]; then
+  matched=true
+  group="Pylint"
+fi
+
+if [[ "$lowercase_message" =~ ^admin(\(.+\))?: ]]; then
+  matched=true
+  group="Administrative"
+fi
+
+#random stuff that doesn't fit into any of the above categories
+#starting with a $
+if [[ "$lowercase_message" =~ ^\$ ]]; then
+  matched=true
+  group="Random"
+fi
+
+# ... (similar checks for other patterns in the list)
+
+# No match found
+if ! $matched; then
+  echo "Error: Commit message header '$message' does not match any defined pattern!\n"
+
+  #list me all possible patterns per group in a nice formatted output
+  echo "Possible patterns are:"
+  echo "  - Group:          Pattern(s)"
+  echo "  - --------------------------------------------"
+  echo "  - Feature:        feat:"
+  echo "  - Fix:            fix:"
+  echo "  - Docs:           docs:, doc:"
+  echo "  - Style:          style:"
+  echo "  - Refactor:       refactor:, ref:"
+  echo "  - Performance:    perf:"
+  echo "  - Test:           test:, tests:"
+  echo "  - Chore:          chore:"
+  echo "  - Merge:          merge:"
+  echo "  - Revert:         revert:"
+  echo "  - Build:          build:"
+  echo "  - Example:        example:, examples:"
+  echo "  - Dependency:     deps:"
+  echo "  - CI:             ci:"
+  echo "  - Pylint:         pylint:"
+  echo "  - Administrative: admin:"
+  echo "  - Random:         $"
+  # ... (similar output for other patterns in the list)
+  echo "  - --------------------------------------------\n"
+
+  echo "Please use one of the patterns above in the commit message header."
+  echo "You can also add a scope in parentheses after the pattern (e.g. 'feat(scope): ...')."
+  exit 1
+fi
+
+# Matched a pattern, check for skip flag (optional)
+if [[ ${skip+unset} ]]; then # Check if skip variable is set
+  if [[ "$lowercase_message" =~ $skip ]]; then
+    echo "Skipping commit '$message' (marked for skipping)"
+    exit 0 # Allow skipping with exit code 0 for a clean commit process
+  fi
+fi
+
+# Check for duplicate Signed-off-by lines (optional)
+test "" = "$(grep '^Signed-off-by: ' "$1" | sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+  echo >&2 "Error: Duplicate Signed-off-by lines found in commit message!"
+  exit 1
+}
+
+# Commit passed checks (optional)
+echo "Commit message '$message' ($group) looks good!"
+
+# Script exits successfully (no need for explicit exit code)

pqenalyzer-0.6.2/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches:
+      -  main
+      - develop
+  pull_request: 
+    branches:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Python
+      uses: actions/setup-python@master
+      with:
+        python-version: '3.12'
+
+    - name: build PQEnalyzer
+      run: |
+        pip install .
+
+    - name: Generate coverage report
+      run: |
+        pip install .[test]
+        python -m pytest -m "not benchmark" --cov=PQEnalyzer --cov-report=xml
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        env_vars: OS,PYTHON
+        fail_ci_if_error: true
+        flags: unittests
+        verbose: true

pqenalyzer-0.6.2/.github/workflows/release.yml

@@ -0,0 +1,156 @@
+name: Publish Python distribution to PyPI and TestPyPI
+
+on: 
+  push:
+    tags:
+      - '**'
+
+permissions: write-all
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.12"
+    - name: Install pypa/build
+      run: |
+        python3 -m pip install build --user
+        python3 -m pip install twine --user
+        python3 -m pip install wheel --user
+
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python distribution to PyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/PQAnalysis
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Create or update GitHub Release
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: setup python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.12'
+
+    - name: build git-changelog
+      run: |
+        python3 -m pip install git-changelog
+
+    - name: Get previous tag
+      id: previousTag
+      run: |
+        name=$(git --no-pager tag --sort=creatordate --merged ${{ github.ref_name }} | tail -2 | head -1)
+        echo "previousTag: $name"
+        echo "previousTag=$name" >> $GITHUB_ENV
+        echo "::set-output name=previousTag::$name"
+
+    - name: generate new changelog
+      run: |
+        name=$(git --no-pager tag --sort=creatordate --merged ${{ github.ref_name }} | tail -2 | head -1)
+        echo "git-changelog=$(git-changelog --sections ci,doc,feat,fix,perf,test -F "$name.." -c angular)" >> $GITHUB_ENV
+
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes "${changelog}"
+
+    - name: Build CHANGELOG.md
+      run: |
+        git-changelog --sections ci,doc,feat,fix,perf,test -o CHANGELOG.md -c angular --in-place
+
+    - name: Add CHANGELOG.md to commit
+      run: |
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+        git config --global user.name "github-actions[bot]"
+
+        git add CHANGELOG.md
+        git commit -m "Docs: Update CHANGELOG.md on release event"
+
+    - name: Push changes
+      if: github.event_name == 'push'
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: 'main'
+
+  pypi-release-update:
+    name: >-
+      Sign the Python distribution with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    - github-release
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v2.1.1
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'

pqenalyzer-0.6.2/.gitignore

@@ -0,0 +1,169 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# VSCode
+.vscode/
+
+# Executables
+main.py
+
+# Version control
+__version__.py