marsh-lib 0.3.0__tar.gz

marsh_lib-0.3.0/.circleci/config.yml

@@ -0,0 +1,73 @@
+version: 2.1
+
+jobs:
+  test:
+    parameters:
+      python-version:
+        type: string
+    docker:
+      - image: cimg/python:<< parameters.python-version >>
+    resource_class: medium
+    steps:
+      - checkout
+      - run:
+          name: Install uv
+          command: |
+            python -m pip install --upgrade pip
+            python -m pip install uv
+      - run:
+          name: Install dependencies
+          command: uv sync --all-groups
+      - run:
+          name: Run baseline tests
+          command: |
+            uv run pytest -vv --disable-warnings --tb=short \
+              --ignore=tests/ssh/test_ssh_connector.py \
+              --ignore=tests/ssh/test_ssh_factory.py \
+              --ignore=tests/docker/
+
+  lint:
+    docker:
+      - image: cimg/python:3.10
+    resource_class: small
+    steps:
+      - checkout
+      - run:
+          name: Install uv
+          command: |
+            python -m pip install --upgrade pip
+            python -m pip install uv
+      - run:
+          name: Install dependencies
+          command: uv sync --all-groups
+      - run:
+          name: Run pflake8
+          command: uv run pflake8 src/marsh --select=E9,F --ignore=F401,F403,F405,F541,F811,F841
+
+  build:
+    docker:
+      - image: cimg/python:3.10
+    resource_class: small
+    steps:
+      - checkout
+      - run:
+          name: Install uv
+          command: |
+            python -m pip install --upgrade pip
+            python -m pip install uv
+      - run:
+          name: Install dependencies
+          command: uv sync --all-groups
+      - run:
+          name: Build wheel
+          command: uv build --wheel --out-dir dist -v
+
+workflows:
+  baseline:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              python-version: ["3.10", "3.11", "3.12"]
+      - lint
+      - build

marsh_lib-0.3.0/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a bug report to help us address the errors in the codebase
+title: "[BUG] Briefly describe the bug"
+labels: bug
+assignees: ''
+
+---
+
+## Describe the Bug
+[A clear and concise description of what the bug is]
+
+## To Reproduce
+[Steps to reproduce the behavior]
+
+## Expected behavior
+[A clear and concise description of what you expected to happen]
+
+## Actual behavior
+[A clear and concise description of what actually happened]
+
+## Screenshots
+[If applicable, add screenshots to help explain your problem]
+
+## Dependencies
+[If applicable, describe or list the dependencies in your setup or environment]
+
+## OS and Environment
+- OS: [e.g. Windows]
+- Distro: [e.g. Ubuntu for Linux OS]
+- Version: [e.g. 22H2 for Windows]
+- Architecture: [e.g. x86_64/amd64]
+- Kernel Version: [e.g. 5.15.0-86-generic for Linux]
+
+## Additional context
+[Add any other context about the issue here]

marsh_lib-0.3.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest ideas, new features, or enhancements for this project
+title: "[FEATURE] Feature name"
+labels: feature
+assignees: ''
+
+---
+
+## Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]. Provide examples, if applicable.
+
+## Describe the solution you'd like
+A clear and concise description of what you want to happen. Provide examples, if applicable.
+
+## Describe alternatives you've considered
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+Add any other context or screenshots about the feature request here.

marsh_lib-0.3.0/.github/ISSUE_TEMPLATE/other.md

@@ -0,0 +1,14 @@
+---
+name: Other
+about: Describe issues other than bug or feature. DO NOT create blank issues
+title: Issue Title
+labels: ''
+assignees: ''
+
+---
+
+## Description
+[Please provide a clear and brief description of the issue or topic]
+
+## Additional information
+[Is there any additional information you'd like to share about this issue?]

marsh_lib-0.3.0/.github/pull_request_template.md

@@ -0,0 +1,24 @@
+## Description
+[Brief and concise description of the changes]
+
+## What kind of changes did you make?
+- [ ] Add new feature or enhancement (core or non-core components)?
+- [ ] Add or update extensions (non-core components)?
+- [ ] Refactor or optimize code?
+- [ ] Fix a bug?
+- [ ] Add or update the documentations?
+- [ ] Add or update the tests?
+
+## Checklist
+- [ ] This PR represents my original work and does not include plagiarized code.
+- [ ] I have read and adhered to the project’s CONTRIBUTING guidelines.
+- [ ] I have followed the project's coding style and guidelines.
+- [ ] Documentation has been updated to reflect changes (e.g., README, inline comments, etc.).
+- [ ] Related API documentation, if any, has been updated.
+- [ ] My code is self-documented with clear comments for complex areas.
+- [ ] Public methods and classes include appropriate docstrings.
+- [ ] Function names, variables, and class names are descriptive and adhere to naming conventions.
+- [ ] I understand that pull requests will not be merged if they do not pass the automated tests.
+- [ ] New functionality is covered by automated tests.
+- [ ] Code changes have been tested across relevant environments or configurations.
+- [ ] I have verified that the changes do not introduce any new vulnerabilities or security risks.

marsh_lib-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,214 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+rc[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+[ab][0-9]+'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build and validate distributions
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout exact release tag
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 1
+          persist-credentials: false
+
+      - name: Verify release tag points to main history
+        run: |
+          git fetch origin main --no-tags
+          git merge-base --is-ancestor "$GITHUB_SHA" "origin/main" || {
+            echo "Release tags must point to a commit contained in main."
+            exit 1
+          }
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        with:
+          version: "0.12.12"
+          enable-cache: false
+
+      - name: Build wheel and source distribution
+        run: uv build --no-sources --out-dir dist
+
+      - name: Validate release version and distribution set
+        env:
+          RELEASE_VERSION: ${{ github.ref_name }}
+        run: |
+          python - <<'PY'
+          import os
+          from pathlib import Path
+          import tomllib
+
+          version = os.environ["RELEASE_VERSION"].removeprefix("v")
+          project = tomllib.loads(Path("pyproject.toml").read_text())["project"]["version"]
+          if project != version:
+              raise SystemExit(
+                  f"Package version {project!r} does not match tag version {version!r}"
+              )
+
+          files = sorted(p.name for p in Path("dist").iterdir() if p.is_file() and not p.name.startswith("."))
+          wheels = [name for name in files if name.endswith(".whl")]
+          sdists = [name for name in files if name.endswith(".tar.gz")]
+
+          if len(wheels) != 1 or len(sdists) != 1 or len(files) != 2:
+              raise SystemExit(f"Expected exactly one wheel and one sdist, found: {files}")
+
+          expected_wheel_prefix = f"marsh_lib-{version}-"
+          expected_sdist = f"marsh_lib-{version}.tar.gz"
+          if not wheels[0].startswith(expected_wheel_prefix):
+              raise SystemExit(f"Unexpected wheel filename: {wheels[0]}")
+          if sdists[0] != expected_sdist:
+              raise SystemExit(f"Unexpected sdist filename: {sdists[0]}")
+
+          print("\n".join(files))
+          PY
+
+      - name: Smoke test wheel
+        run: uv run --isolated --no-project --with dist/*.whl python -c "import marsh; print(marsh.__file__)"
+
+      - name: Smoke test source distribution
+        run: uv run --isolated --no-project --with dist/*.tar.gz python -c "import marsh; print(marsh.__file__)"
+
+      - name: Record artifact hashes
+        run: sha256sum dist/* | tee dist/SHA256SUMS
+
+      - name: Upload exact release distributions
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+          retention-days: 14
+
+  release:
+    name: Create GitHub Release
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: read
+    steps:
+      - name: Checkout exact release tag
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Download exact release distributions
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist
+
+      - name: Build changelog
+        id: build_changelog
+        uses: mikepenz/release-changelog-builder-action@c9dc8369bccbc41e0ac887f8fd674f5925d315f7 # v5
+        with:
+          configuration: |
+            {
+              "categories": [
+                {"title": "## 🚀 Features", "labels": ["feature", "extension", "core", "enhancement"]},
+                {"title": "## 🐛 Bug Fixes", "labels": ["bug", "bugfix", "fix"]},
+                {"title": "## 🧪 Tests", "labels": ["test"]},
+                {"title": "## 🛠️ Maintenance", "labels": ["documentation", "cicd"]},
+                {"title": "## 🚫 Deprecated", "labels": ["deprecate"]}
+              ],
+              "ignore_labels": ["wip", "do-not-merge"],
+              "sort": {"order": "ASC", "on_property": "mergedAt"},
+              "template": "# Release Notes for #{{TO_TAG}}\n\n#{{CHANGELOG}}\n\n<details>\n<summary>Uncategorized</summary>\n\n#{{UNCATEGORIZED}}\n</details>",
+              "pr_template": "- #{{TITLE}} ([#{{NUMBER}}](#{{URL}})) by @#{{AUTHOR}}"
+            }
+          fetchReleaseInformation: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create GitHub Release with exact artifacts
+        uses: ncipollo/release-action@339a81892b84b4eeb0f6e744e4574d79d0d9b8dd # v1.21.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          body: ${{ steps.build_changelog.outputs.changelog }}
+          artifacts: "dist/*.whl,dist/*.tar.gz"
+          allowUpdates: false
+          draft: false
+
+  publish:
+    name: Publish exact artifacts to PyPI
+    needs: release
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Install uv
+        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        with:
+          version: "0.12.12"
+          enable-cache: false
+
+      - name: Download exact release distributions
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist
+
+      - name: Generate PEP 740 attestations
+        uses: astral-sh/attest-action@f589a42a7efb6fe400b4f400de60b4bc90390027 # v0.0.6
+        with:
+          paths: |
+            dist/*.whl
+            dist/*.tar.gz
+
+      - name: Publish exact artifacts to PyPI
+        run: uv publish
+
+      - name: Verify published artifact hashes
+        env:
+          RELEASE_VERSION: ${{ github.ref_name }}
+        run: |
+          python - <<'PY'
+          import hashlib
+          import json
+          import os
+          from pathlib import Path
+          import urllib.request
+
+          version = os.environ["RELEASE_VERSION"].removeprefix("v")
+          url = f"https://pypi.org/pypi/marsh-lib/{version}/json"
+          with urllib.request.urlopen(url, timeout=30) as response:
+              payload = json.load(response)
+
+          expected = {
+              path.name: hashlib.sha256(path.read_bytes()).hexdigest()
+              for path in Path("dist").glob("*")
+              if path.is_file() and not path.name.endswith(".attestation")
+          }
+          published = {
+              item["filename"]: item["digests"]["sha256"]
+              for item in payload["urls"]
+          }
+
+          missing = sorted(set(expected) - set(published))
+          mismatched = sorted(
+              name for name, digest in expected.items()
+              if published.get(name) != digest
+          )
+          if missing or mismatched:
+              raise SystemExit(
+                  f"PyPI verification failed; missing={missing}, mismatched={mismatched}"
+              )
+          print(f"Verified {len(expected)} published artifact hashes for marsh-lib {version}")
+          PY

marsh_lib-0.3.0/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+name: Python Test
+
+on:
+  push:
+    branches: ["*"]
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  lint_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v10.2.0
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-groups
+
+      # TODO: Setup Docker for testing docker components (and possible ssh components).
+      - name: Run pytest
+        run: |
+          cd src
+          uv run --with coverage --with pytest-cov pytest \
+            -vv --disable-warnings \
+            --tb=short --cov-report xml:../coverage.xml --cov=marsh \
+            --ignore=../tests/ssh/test_ssh_connector.py \
+            --ignore=../tests/ssh/test_ssh_factory.py \
+            --ignore=../tests/docker/ \
+            ../tests/
+
+      - name: Get Coverage
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: orgoro/coverage@v3.2
+        with:
+            coverageFile: coverage.xml
+            token: ${{ secrets.GITHUB_TOKEN }}

marsh_lib-0.3.0/.gitignore

@@ -0,0 +1,177 @@
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.env.*
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+!.env.sample
+!.env.*.sample
+
+# 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/
+
+# VS Code
+.vscode
+.vs
+
+# Nektos Act
+.secrets
+*.secrets
+.vars
+*.vars
+
+# Task
+.task/

marsh_lib-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Cedric Anover
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.