hyrum 0.0.0__tar.gz

hyrum-0.0.0/.github/dependabot.yaml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"  # This is hard-coded to the 1st of the month
+    labels:
+      - "dependencies"
+    cooldown:
+      default-days: 7
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    labels:
+      - "dependencies"
+    cooldown:
+      default-days: 7

hyrum-0.0.0/.github/workflows/ci.yaml

@@ -0,0 +1,61 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["**"]
+
+permissions: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b  # v8.1.0
+        with:
+          enable-cache: true
+      - run: uvx --with tox-uv tox -e lint
+
+  static:
+    name: static (pyright)
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b  # v8.1.0
+        with:
+          enable-cache: true
+      - run: uvx --with tox-uv tox -e static
+
+  unit:
+    name: unit (py${{ matrix.python }})
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b  # v8.1.0
+        with:
+          enable-cache: true
+      - run: uv python install ${{ matrix.python }}
+      - run: uvx --with tox-uv --python ${{ matrix.python }} tox -e unit

hyrum-0.0.0/.github/workflows/publish.yaml

@@ -0,0 +1,43 @@
+name: publish
+
+on:
+  push:
+    tags: ['v*']
+
+permissions: {}
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b  # v8.1.0
+        with:
+          enable-cache: false
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: Publish to PyPI (trusted publishing)
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: publish-pypi
+      url: https://pypi.org/p/hyrum
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

hyrum-0.0.0/.github/workflows/zizmor.yaml

@@ -0,0 +1,21 @@
+# Caller for the canonical/charm-tech reusable zizmor workflow.
+#
+# Pinned to a commit SHA, not @main, so a change in canonical/charm-tech can't
+# silently alter this repo's CI. The pinned SHA below points at the tip of
+# canonical/charm-tech PR #2 (initial-scaffolding) — once that PR squash-merges
+# to main, retarget to the resulting commit on main.
+name: Workflow static checks
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["**"]
+
+permissions: {}
+
+jobs:
+  zizmor:
+    uses: canonical/charm-tech/.github/workflows/zizmor.yaml@98bbae0fc022a7da50f9b3fcc02b54a87de26d42  # PR #2 tip
+    permissions:
+      security-events: write

hyrum-0.0.0/.github/zizmor.yml

@@ -0,0 +1,10 @@
+# zizmor policy for hyrum. The team convention (per the canonical/charm-tech
+# estate audit) is: SHA-pin all third-party actions, and accept ref pins only
+# for actions owned by GitHub or PyPA.
+rules:
+  unpinned-uses:
+    config:
+      policies:
+        "actions/*": ref-pin
+        "github/*": ref-pin
+        "pypa/*": ref-pin

hyrum-0.0.0/.gitignore

@@ -0,0 +1,31 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+
+# Tooling
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+.tox/
+.coverage
+coverage.xml
+htmlcov/
+
+# Editors
+.idea/
+.vscode/
+*.swp
+.DS_Store
+
+# Tool output
+.hyrum-logs/
+results-*.json
+
+# uv
+.python-version

hyrum-0.0.0/.pre-commit-config.yaml

@@ -0,0 +1,54 @@
+# Pre-commit config aligned with canonical/charm-tech templates/pre-commit-config.yaml.
+# ruff, codespell, and zizmor are local hooks run via uv so they use the same
+# versions as CI and manual `tox -e lint` runs.
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-json
+      - id: check-yaml
+      - id: check-toml
+      - id: mixed-line-ending
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: detect-private-key
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        description: "Run 'ruff check' for extremely fast Python linting"
+        entry: uv run ruff check --preview --force-exclude
+        language: system
+        types_or: [python, pyi, jupyter]
+        require_serial: true
+      - id: ruff-format
+        name: ruff format
+        description: "Run 'ruff format' for extremely fast Python formatting"
+        entry: uv run ruff format --preview --force-exclude
+        language: system
+        types_or: [python, pyi, jupyter]
+        require_serial: true
+      - id: zizmor
+        name: zizmor
+        description: "Find security issues in GitHub Actions CI/CD setups"
+        language: system
+        types: [yaml]
+        files: (\.github/workflows/.*)|(action\.ya?ml)$
+        require_serial: true
+        entry: uv run zizmor
+        args:
+          - "--no-progress"
+      - id: codespell
+        name: codespell
+        description: Checks for common misspellings in text files.
+        entry: uv run codespell
+        language: system
+        types: [text]
+        require_serial: true

hyrum-0.0.0/AGENTS.md

@@ -0,0 +1,76 @@
+# AGENTS.md
+
+This file provides guidance to AI agents when working with code in this repository.
+
+## Project Overview
+
+`hyrum` bulk-runs a check (typically lint or unit tests) across many charm
+repositories, optionally swapping out one of their dependencies first — for
+example, pointing every charm's `ops` dependency at a development branch of
+the [operator](https://github.com/canonical/operator) repo to see which charms
+it breaks. The runner backend is either `tox` or `make`, auto-detected per
+charm.
+
+Named for [Hyrum's law](https://www.hyrumslaw.com/): the tool exists to
+surface the consumers who depend on observable behaviour of an upstream
+dependency before that behaviour changes.
+
+## Common Commands
+
+```bash
+tox -e lint    # ruff check + ruff format --check + codespell
+tox -e static  # pyright (strict)
+tox -e unit    # pytest with coverage
+tox -e format  # apply ruff formatting
+```
+
+`uv` is the dependency manager (see `pyproject.toml`'s `[dependency-groups]`).
+Pre-commit hooks mirror the CI checks; install them with `pre-commit install`.
+
+## Code and Documentation Style
+
+This project follows the Charm Tech team style guides. Read them if more
+clarification is required:
+
+- [Documentation and docstring style](https://github.com/canonical/charm-tech/blob/main/STYLE.md)
+- [Python style](https://github.com/canonical/charm-tech/blob/main/python/STYLE.md)
+
+Ensure that `pre-commit` is installed (with the user's permission) so that
+style is enforced with every commit. If the user does not permit using
+`pre-commit`, *always* ensure `tox -e lint,static,unit` shows no issues
+before committing.
+
+Avoid writing prose documentation: that is a task for humans. When reviewing
+documentation, pay particular attention to consistency with the style guides
+above.
+
+## Architecture
+
+- Entry point: `hyrum.cli:main` (a single Click command).
+- `enumerate` / `filters` / `frameworks` / `config` — repo selection. Charm
+  collection curation is **out of scope**; the tool expects a pre-populated
+  cache folder.
+- `patchers/` — `Patcher` protocol, `NullPatcher`, `PatcherStack`,
+  `OpsSourcePatcher`. The protocol is deliberately narrow so a future
+  charm-library patcher (vendored `lib/charms/…/v<n>/<file>.py` swapped from a
+  git source) can slot in without changes elsewhere.
+- `runners/` — `ToxRunner`, `MakeRunner`, `auto()` per-charm with fallback.
+  GNU make's missing-target ambiguity is handled by probing with
+  `make -nq` and falling back to stderr inspection.
+- `pool` — async worker pool, `Outcome` dataclass with `patcher_error` as a
+  status distinct from `failed` (so infrastructure problems don't get
+  mis-attributed to the charm).
+- `report` — Rich tally + verbose offender lists.
+
+Scope during the 26.10 cycle is **lint and unit tests only**. Do not add
+integration-test support.
+
+## Testing
+
+- Unit tests live in `tests/` and follow the layout of `src/hyrum/`.
+- Subprocess-driven runners are tested with a `FakeProc` / `FakeSpawner`
+  pair (see `tests/test_runners.py`) that monkeypatches
+  `asyncio.create_subprocess_exec` — no real subprocesses are spawned in
+  the unit suite.
+- The ops-source patcher's lockfile regeneration is monkeypatched out (the
+  `_run_lock` helper) so unit tests don't spawn `poetry` / `uv`.

hyrum-0.0.0/CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

hyrum-0.0.0/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+We welcome contributions to hyrum!
+
+Before working on changes, please consider [opening an issue](https://github.com/canonical/hyrum/issues) explaining your use case. If you would like to chat with us about your use cases or proposed implementation, you can reach us at [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) or [Discourse](https://discourse.charmhub.io/).
+
+# Pull requests
+
+Changes are proposed as [pull requests on GitHub](https://github.com/canonical/hyrum/pulls).
+
+Pull requests should have a short title that follows the [conventional commit style](https://www.conventionalcommits.org/en/) using one of these types:
+
+- chore
+- ci
+- docs
+- feat
+- fix
+- perf
+- refactor
+- revert
+- test
+
+Some examples:
+
+- feat: add a `make` runner alongside the existing `tox` one
+- fix: restore poetry.lock when patching is aborted by Ctrl-C
+- docs: clarify how `--ops-source-branch` interacts with charm extras
+
+We consider this project too small to use scopes, so we don't use them.
+
+Note that the commit messages to the PR's branch do not need to follow the conventional commit format, as these will be squashed into a single commit to `main` using the PR title as the commit message.
+
+To help us review your changes, please rebase your pull request onto the `main` branch before you request a review. If you need to bring in the latest changes from `main` after the review has started, please use a merge commit.
+
+# Tests
+
+Changes should include tests. Run them locally with:
+
+```bash
+tox -e lint,static,unit
+```
+
+`unit` is the canonical unit test environment; `lint` covers `ruff check`, `ruff format --check`, and `codespell`; `static` runs `pyright` in strict mode.
+
+# Coding style
+
+We follow the Charm Tech team style guides:
+
+- [Documentation and docstring style](https://github.com/canonical/charm-tech/blob/main/STYLE.md)
+- [Python style](https://github.com/canonical/charm-tech/blob/main/python/STYLE.md)
+
+Most of this is enforced by CI checks.

hyrum-0.0.0/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.