ezbak 0.2.0__tar.gz

ezbak-0.2.0/.github/actions/setup_python_env/action.yml

@@ -0,0 +1,33 @@
+---
+name: Install uv, Python, and project dependencies
+description: Install uv, Python, and project dependencies using cached uv and Python installations
+
+inputs:
+  python-version:
+    description: >
+      Version range or exact version of a Python version to use, using SemVer's version range syntax.
+    required: false
+    default: "3.12"
+
+outputs:
+  python-version:
+    description: The installed python version. Useful when given a version range as input.
+    value: ${{ steps.setup-python.outputs.python-version }}
+
+runs:
+  using: composite
+  steps:
+    - name: Setup uv with cache
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: "latest"
+        enable-cache: true
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install the project
+      shell: bash
+      run: uv sync --all-extras --dev
+
+    - name: Minimize uv cache
+      shell: bash
+      run: uv cache prune --ci

ezbak-0.2.0/.github/dependabot.yml

@@ -0,0 +1,23 @@
+---
+version: 2
+
+updates:
+    - package-ecosystem: github-actions
+      directory: /
+      schedule:
+          interval: monthly
+      commit-message:
+          prefix: "ci"
+          prefix-development: "ci"
+          include: "scope"
+    # - package-ecosystem: pip
+    #   directory: /
+    #   schedule:
+    #       interval: monthly
+    #   commit-message:
+    #       prefix: "build"
+    #       prefix-development: "build"
+    #       include: "scope"
+    #   versioning-strategy: lockfile-only
+    #   allow:
+    #       - dependency-type: "all"

ezbak-0.2.0/.github/workflows/commit-linter.yml

@@ -0,0 +1,35 @@
+---
+name: Commit Linter
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        types:
+            - opened
+            - reopened
+            - synchronize
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+permissions: # added using https://github.com/step-security/secure-workflows
+    contents: read
+
+jobs:
+    lint-commits:
+        if: "!contains(github.event.head_commit.message, 'bump(release)')"
+        permissions:
+            contents: read # for actions/checkout to fetch code
+            pull-requests: read # for wagoid/commitlint-github-action to get commits in PR
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Lint commits
+              uses: wagoid/commitlint-github-action@v6

ezbak-0.2.0/.github/workflows/create-release.yml

@@ -0,0 +1,118 @@
+---
+name: "Create Release"
+
+on:
+    workflow_dispatch:
+    push:
+        tags:
+            - "v*"
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
+permissions:
+    contents: write
+
+jobs:
+    auto-release:
+        name: Create Release
+        runs-on: "ubuntu-latest"
+        strategy:
+            fail-fast: true
+            matrix:
+                python-version: ["3.11"]
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            # ----------------------------------------------
+            #    Grab version number
+            # ----------------------------------------------
+
+            - name: Add version to environment vars
+              run: |
+                  PROJECT_VERSION=$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')
+                  echo "PROJECT_VERSION=$PROJECT_VERSION" >> $GITHUB_ENV
+
+            # ----------------------------------------------
+            # Confirm we did, in fact, update the version
+            # ----------------------------------------------
+
+            - name: Check if tag version matches project version
+              run: |
+                  TAG=$(git describe HEAD --tags --abbrev=0)
+                  echo $TAG
+                  echo $PROJECT_VERSION
+                  if [[ "$TAG" != "v$PROJECT_VERSION" ]]; then exit 1; fi
+                  echo "CURRENT_TAG=refs/tags/${TAG}" >> $GITHUB_ENV
+
+            # ----------------------------------------------
+            # Test and then build the package
+            # ----------------------------------------------
+
+            - name: Run tests
+              shell: bash
+              run: uv run duty test
+
+            - name: Build the package
+              shell: bash
+              run: uv build
+
+            # ----------------------------------------------
+            # Generate release notes
+            # ----------------------------------------------
+
+            # - name: Release Notes
+            #   run: git log $(git describe HEAD~ --tags --abbrev=0)..HEAD --pretty='format:* %h %s' --no-merges >> ".github/RELEASE-TEMPLATE.md"
+
+            - name: Get notes
+              id: generate_notes
+              uses: anmarkoulis/commitizen-changelog-reader@master
+              with:
+                  tag_name: ${{ env.CURRENT_TAG }}
+                  changelog: CHANGELOG.md
+
+            # ----------------------------------------------
+            # Build draft release (Note: Will need to manually publish)
+            # ----------------------------------------------
+
+            - name: Create Github Release
+              uses: softprops/action-gh-release@v2
+              with:
+                  body: ${{join(fromJson(steps.generate_notes.outputs.notes).notes, '')}}
+                  draft: false
+                  files: |
+                      dist/*-${{env.PROJECT_VERSION}}-py3-none-any.whl
+                      dist/*-${{env.PROJECT_VERSION}}.tar.gz
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    publish-to-pypi:
+        runs-on: ubuntu-latest
+        needs: auto-release
+        env:
+            TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
+            TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+        strategy:
+            matrix:
+                python-version: ["3.11"]
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            - name: Build the package
+              shell: bash
+              run: uv build
+
+            - name: Upload to PyPi
+              shell: bash
+              run: uvx twine upload dist/*

ezbak-0.2.0/.github/workflows/manual_pypy_publish.yml

@@ -0,0 +1,36 @@
+---
+name: "Manual PyPy Publish"
+
+on:
+    workflow_dispatch:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
+permissions:
+    contents: write
+
+jobs:
+    publish-to-pypi:
+        runs-on: ubuntu-latest
+        env:
+            TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
+            TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+        strategy:
+            matrix:
+                python-version: ["3.11"]
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            - name: Build the package
+              shell: bash
+              run: uv build
+
+            - name: Upload to PyPi
+              shell: bash
+              run: uvx twine upload dist/*

ezbak-0.2.0/.github/workflows/pr-linter.yml

@@ -0,0 +1,50 @@
+---
+name: Pull Request Linter
+
+on:
+    pull_request_target:
+        types:
+            - opened
+            - edited
+            - synchronize
+        branches:
+            - main
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+permissions: # added using https://github.com/step-security/secure-workflows
+    contents: read
+
+jobs:
+    lint:
+        permissions:
+            pull-requests: read # for amannn/action-semantic-pull-request to analyze PRs
+            statuses: write # for amannn/action-semantic-pull-request to mark status of analyzed PR
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Lint Pull Request
+              uses: amannn/action-semantic-pull-request@v5
+              with:
+                  validateSingleCommit: true
+                  wip: true
+                  types: |
+                      fix
+                      feat
+                      docs
+                      style
+                      refactor
+                      perf
+                      test
+                      build
+                      ci
+                  requireScope: false
+                  subjectPattern: ^(?![A-Z]).+$
+                  subjectPatternError: |
+                      The subject "{subject}" found in the pull request title "{title}"
+                      didn't match the configured pattern. Please ensure that the subject
+                      doesn't start with an uppercase character.
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

ezbak-0.2.0/.github/workflows/test.yml

@@ -0,0 +1,73 @@
+---
+name: "Tests"
+
+on:
+    workflow_dispatch:
+    push:
+        paths:
+            - ".github/workflows/test.yml"
+            - ".github/actions/**"
+            - "**.py"
+            - "pyproject.toml"
+            - "uv.lock"
+        branches:
+            - main
+    pull_request:
+        types:
+            - opened
+            - reopened
+            - synchronize
+        paths:
+            - ".github/workflows/test.yml"
+            - ".github/actions/**"
+            - "**.py"
+            - "pyproject.toml"
+            - "uv.lock"
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    test-python-code:
+        runs-on: ubuntu-latest
+        strategy:
+            fail-fast: true
+            matrix:
+                python-version: ["3.10", "3.11", "3.12", "3.13"]
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            - name: Run tests
+              shell: bash
+              run: uv run duty test
+
+            - name: Upload coverage to Codecov
+              if: ${{ matrix.python-version == '3.12' }}
+              uses: codecov/codecov-action@v5
+              with:
+                  files: .cache/coverage.xml
+              env:
+                  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+    lint-project:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - uses: actions/cache@v4
+              with:
+                  path: ~/.cache/pre-commit
+                  key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+            - name: Setup Python, uv, and the package
+              uses: ./.github/actions/setup_python_env
+
+            - name: run all linters
+              shell: bash
+              run: uv run duty lint

ezbak-0.2.0/.gitignore

@@ -0,0 +1,20 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Project specific
+.cache/
+.development/
+.cursor/
+tmp/
+.development/
+
+# macOS
+.DS_Store

ezbak-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,110 @@
+---
+# https://pre-commit.com
+default_install_hook_types: [pre-commit, pre-push, commit-msg]
+default_stages: [pre-commit, manual]
+fail_fast: true
+repos:
+  - repo: "https://github.com/commitizen-tools/commitizen"
+    rev: v4.8.3
+    hooks:
+      - id: commitizen
+      - id: commitizen-branch
+        stages:
+          - pre-push
+
+  - repo: "https://github.com/pre-commit/pygrep-hooks"
+    rev: v1.10.0
+    hooks:
+      - id: python-check-mock-methods
+      - id: python-no-eval
+      - id: python-no-log-warn
+      - id: python-use-type-annotations
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+      - id: text-unicode-replacement-char
+
+  - repo: "https://github.com/pre-commit/pre-commit-hooks"
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-json
+        exclude: .devcontainer/|.vscode/
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-vcs-permalinks
+      - id: check-xml
+      - id: check-yaml
+      - id: debug-statements
+      - id: destroyed-symlinks
+      - id: detect-private-key
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+        types: [python]
+        args: [--markdown-linebreak-ext=md]
+      - id: end-of-file-fixer
+        types: [python]
+
+  - repo: "https://github.com/adrienverge/yamllint.git"
+    rev: v1.37.1
+    hooks:
+      - id: yamllint
+        files: ^.*\.(yaml|yml)$
+        entry: yamllint --strict --config-file .yamllint.yml
+
+  - repo: "https://github.com/astral-sh/ruff-pre-commit"
+    rev: "v0.11.13"
+    hooks:
+      - id: ruff-check
+        exclude: tests/
+        args: [--no-fix]
+      - id: ruff-format
+        args: [--check]
+
+  - repo: "https://github.com/adhtruong/mirrors-typos"
+    rev: v1.33.1
+    hooks:
+      - id: typos
+        args: ["--force-exclude"]
+        stages: [commit-msg, pre-commit]
+
+  - repo: "https://github.com/crate-ci/committed"
+    rev: v1.1.7
+    hooks:
+      - id: committed
+        stages: [commit-msg]
+
+  - repo: "https://github.com/gitleaks/gitleaks"
+    rev: v8.27.2
+    hooks:
+      - id: gitleaks
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: mypy --config-file pyproject.toml
+        exclude: "tests/|duties.py|tmp/"
+        language: system
+        types: [python]
+
+      - id: pytest
+        name: pytest
+        entry: pytest -c pyproject.toml src/ tests/
+        language: system
+        pass_filenames: false
+        files: |
+          (?x)^(
+          src/|
+          tests/|
+          uv\.lock|
+          pyproject\.toml
+          )

ezbak-0.2.0/.python-version

@@ -0,0 +1 @@
+3.13

ezbak-0.2.0/.typos.toml

@@ -0,0 +1,9 @@
+[default]
+    default.locale = "en_us"
+
+    [default.extend-words]
+        ezbak = "ezbak"
+        nd    = "nd"
+
+[files]
+    extend-exclude = ["*_cache", ".cache", ".venv", "tmp"]

ezbak-0.2.0/.yamllint.yml

@@ -0,0 +1,32 @@
+---
+# Find full documentation at: https://yamllint.readthedocs.io/en/stable/index.html
+extends: default
+
+ignore: |
+  .venv
+  .cache
+rules:
+  braces:
+    level: error
+    max-spaces-inside: 1
+    min-spaces-inside: 1
+  comments-indentation: disable
+  comments:
+    min-spaces-from-content: 1
+  indentation:
+    spaces: consistent
+    indent-sequences: true
+    check-multi-line-strings: false
+  line-length: disable
+  quoted-strings:
+    quote-type: any
+    required: false
+    extra-required:
+      - "^http://"
+      - "^https://"
+      - "ftp://"
+      - 'ssh \w.*'
+    extra-allowed: []
+  truthy:
+    level: error
+    check-keys: false

ezbak-0.2.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+## v0.2.0 (2025-06-16)
+
+### Feat
+
+- initial commit

ezbak-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing to ezbak
+
+Thank you for your interest in contributing to ezbak! This document provides guidelines and instructions to make the contribution process smooth and effective.
+
+## Types of Contributions Welcome
+
+-   Bug fixes
+-   Feature enhancements
+-   Documentation improvements
+-   Test additions
+
+## Development Setup
+
+### Prerequisites
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management. To start developing:
+
+1. Install uv using the [recommended method](https://docs.astral.sh/uv/installation/) for your operating system
+2. Clone this repository: `git clone https://github.com/natelandau/ezbak`
+3. Navigate to the repository: `cd ezbak`
+4. Install dependencies with uv: `uv sync`
+5. Activate your virtual environment: `source .venv/bin/activate`
+6. Install pre-commit hooks: `pre-commit install --install-hooks`
+
+### Running Tasks
+
+We use [Duty](https://pawamoy.github.io/duty/) as our task runner. Common tasks:
+
+-   `duty --list` - List all available tasks
+-   `duty lint` - Run all linters
+-   `duty test` - Run all tests
+
+## Development Guidelines
+
+When developing for ezbak, please follow these guidelines:
+
+-   Write full docstrings
+-   All code should use type hints
+-   Write unit tests for all new functions
+-   Write integration tests for all new features
+-   Follow the existing code style
+
+## Commit Process
+
+1. Create a branch for your feature or fix
+2. Make your changes
+3. Ensure code passes linting with `duty lint`
+4. Ensure tests pass with `duty test`
+5. Commit using [Commitizen](https://github.com/commitizen-tools/commitizen): `cz c`
+6. Push your branch and create a pull request
+
+We use [Semantic Versioning](https://semver.org/) for version management.

ezbak-0.2.0/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Nate Landau
+
+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.