fabrictestbed_extensions 1.9.0__tar.gz

fabrictestbed_extensions-1.9.0/.github/workflows/build.yml

@@ -0,0 +1,49 @@
+# Build the package
+
+name: Build
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out sources
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+          cache: 'pip'  # cache pip dependencies
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flit
+
+      - name: Build the package
+        run: |
+          python -m flit build
+
+      - name: Try installing the package
+        run: |
+          python -m pip install dist/fabrictestbed_extensions-*.whl
+
+      # See https://github.com/actions/upload-artifact
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: packages
+          path: dist/
+          if-no-files-found: error

fabrictestbed_extensions-1.9.0/.github/workflows/check_docstring_coverage.yml

@@ -0,0 +1,42 @@
+# A check to ensure that our docstring coverage remains pretty good.
+#
+# We use interrogate (https://interrogate.readthedocs.io/) to check
+# docstring coverage.  Settings are under `[tool.interrogate]` section
+# of the pyproject.toml file in the top-level directory.
+
+name: Check docstring coverage
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+
+  checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out sources
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+          cache: 'pip'  # cache pip dependencies
+          cache-dependency-path: pyproject.toml
+
+      - name: Install interrogate
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install interrogate==1.7.0
+
+      - name: Check docstring coverage with interrogate
+        run: |
+          python -m interrogate -vv fabrictestbed_extensions

fabrictestbed_extensions-1.9.0/.github/workflows/check_format.yml

@@ -0,0 +1,50 @@
+# Run some code checks with GitHub Actions.
+
+name: Code formatting checks
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out sources
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # since we need to diff against origin/main.
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+          cache: 'pip'  # cache pip dependencies
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install black==24.* isort==5.*
+
+      - name: Run "black --check"
+        run: |
+          python -m black --check .
+
+      - name: Run "isort --check"
+        run: |
+          python -m isort --profile black --check .
+
+      # Remind PR authors to update CHANGELOG.md
+      - name: Check that Changelog has been updated
+        if: github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'no changelog')
+        run: |
+          # `git diff --exit-code` exits with 1 if there were
+          # differences and 0 means no differences. Here we negate
+          # that, because we want to fail if changelog has not been
+          # updated.
+          ! git diff --exit-code "origin/${GITHUB_BASE_REF}" -- CHANGELOG.md

fabrictestbed_extensions-1.9.0/.github/workflows/check_signed_commits.yml

@@ -0,0 +1,32 @@
+# FABRIC policy requires that code commits are signed with the
+# committer's GPG key.
+#
+# https://github.com/marketplace/actions/check-signed-commits-in-pr
+# runs on pull_request_target events.
+
+name: Check signed commits in PR
+on: pull_request_target
+
+jobs:
+  check-signed-commits:
+    name: Check signed commits in PR
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      # Allow 1Password/check-signed-commits-action to leave comments
+      # on pull requests.
+      pull-requests: write
+
+    steps:
+      - name: Check signed commits in PR
+        uses: 1Password/check-signed-commits-action@v1
+        with:
+          comment: |
+            ⚠️ This PR contains unsigned commits. To get your PR merged, please sign those commits (`git rebase --exec 'git commit -S --amend --no-edit -n' @{upstream}`) and force push them to this branch (`git push --force-with-lease`).
+
+            If you're new to commit signing, follow the steps below to set up commit signing with `gpg`:
+
+            1. [Generate a GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key)
+            2. [Add the GPG key to your GitHub account](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)
+            3. [Configure `git` to use your GPG key for commit signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key#telling-git-about-your-gpg-key)

fabrictestbed_extensions-1.9.0/.github/workflows/publish.yml

@@ -0,0 +1,68 @@
+# Publish the package on PyPI.
+#
+# https://pypi.org/project/fabrictestbed-extensions/ is configured
+# with GitHub as "trusted publisher", meaning, there is no exchange of
+# a long-term password or token between GitHub and PyPI.  See
+# documentation here: https://docs.pypi.org/trusted-publishers/
+
+name: Publish
+
+# This workflow will be triggered when a tag with prefix "rel" is
+# pushed to the repository.
+on:
+  push:
+    tags:
+      - "rel*"
+
+jobs:
+  tests:
+    uses: ./.github/workflows/test.yml
+
+  pypi-publish:
+    name: Publish packages on PyPI
+    runs-on: ubuntu-latest
+    needs:
+      - tests
+
+    environment:
+      name: publish
+      url: https://pypi.org/p/fabrictestbed-extensions
+
+    # See https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs
+    permissions:
+      # This permission is mandatory for trusted publishing.
+      id-token: write
+      # This permission allows the action to create a release.
+      contents: write
+
+    steps:
+      - name: Check out sources
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+
+      - name: Build package
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flit
+          python -m flit build
+
+      # See https://github.com/marketplace/actions/pypi-publish.
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      # GitHub CLI (aka "gh" command) is pre-installed in hosted runners.
+      # See https://docs.github.com/en/actions/using-workflows/using-github-cli-in-workflows
+      - name: Create a GitHub release
+        run: |
+          RELEASE_TAG=$GITHUB_REF_NAME
+          RELEASE_TITLE="Release $(echo "$RELEASE_TAG" | sed 's/^rel//g')"
+          echo "RELEASE_TAG=${RELEASE_TAG}, RELEASE_TITLE=${RELEASE_TITLE}"
+          gh release create ${RELEASE_TAG} --title="${RELEASE_TITLE}" --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

fabrictestbed_extensions-1.9.0/.github/workflows/test.yml

@@ -0,0 +1,85 @@
+# This workflow will install Python dependencies, run tests and lint
+# with a variety of Python versions For more information see:
+# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Test
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  test:
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+        os:
+          # See https://github.com/actions/runner-images for available
+          # runners.
+          - "ubuntu-22.04"
+          - "windows-2022"
+          - "macos-13" # Intel
+          - "macos-14" # ARM
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: Check out sources
+      uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'  # caching pip dependencies
+        cache-dependency-path: pyproject.toml
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install wheel
+
+    # # TODO: we can't use flake8 right now, because there isn't a
+    # # version of flake8 that can use pycodestyle==2.6.0, and fim has
+    # # pinned pycodestyle==2.6.0.
+    # - name: Lint with flake8
+    #   run: |
+    #     # stop the build if there are Python syntax errors or undefined names
+    #     python -m flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+    #     # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+    #     python -m flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+    - name: Install and test with pytest
+      run: |
+        python -m pip install .[test]
+        python -m coverage run -m pytest
+        python -m coverage report
+        # Generate LCOV format coverage data for coveralls.
+        python -m coverage lcov -o coverage.lcov
+ 
+    - name: Send coverage data to coveralls.io
+      uses: coverallsapp/github-action@v2
+      with:
+        flag-name: run-${{ join(matrix.*, '-') }}
+        file: coverage.lcov
+        parallel: true
+
+  finalize:
+    name: finalize
+    needs: test
+    runs-on: ubuntu-latest
+    if: ${{ always() }}
+    steps:
+      - name: Indicate completion to coveralls.io
+        uses: coverallsapp/github-action@v2
+        with:
+          parallel-finished: true

fabrictestbed_extensions-1.9.0/.gitignore

@@ -0,0 +1,133 @@
+# 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/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+.idea/
+
+# Created by tox.
+/_trial_temp/

fabrictestbed_extensions-1.9.0/.readthedocs.yaml

@@ -0,0 +1,25 @@
+# Configuration for readthedocs.org.
+# See https://docs.readthedocs.io/en/latest/config-file/v2.html
+
+version: 2
+
+# readthedocs.org uses Python 3.7 by default; fablib has to use Python
+# 3.9 or greater.  This incantation seems to work.
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+# Tell RTD location of our Sphinx configuration.  Seems to work
+# without this too, although default is docs/conf.py.
+sphinx:
+  configuration: docs/source/conf.py
+
+# To be able to build API documentation, we need to install both docs
+# requirements and package requirements, it seems.
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc