kemperrig 0.1.0__tar.gz

kemperrig-0.1.0/.env.example

@@ -0,0 +1,22 @@
+# Copy to .env (gitignored) and point at your own files.
+# All optional: every command still accepts an explicit path / --criteria.
+
+# Default library for every command — a .rmbackup, or the live Rig Manager directory
+# (`history` reads that directory's Backups/ folder).
+KEMPERRIG_LIBRARY="$HOME/Library/Application Support/Kemper Amps/RigManager"
+
+# Default criteria file for `shortlist`. Start from config/example-shortlist.json.
+KEMPERRIG_CRITERIA="./config/example-shortlist.json"
+
+# A census written by `kemperrig summary --write-golden`. With KEMPERRIG_LIBRARY set too,
+# tests/test_golden.py checks that library still matches it; without both, it skips.
+# KEMPERRIG_GOLDEN="/path/to/your/golden.json"
+
+# If you keep rigs pulled off the Profiler in their own library folder, name it here and
+# `analyze` will exempt it from the orphan sweep. There is no default — the name is your
+# filing convention, not something Rig Manager defines.
+# KEMPERRIG_RACK_FOLDER="Rack"
+
+# Where effect type names come from. Defaults to the Stomps.xml inside a standard Rig
+# Manager install; set this only if yours lives elsewhere.
+# KEMPERRIG_STOMPS_XML="/Applications/Rig Manager.app/Contents/Resources/Stomps.xml"

kemperrig-0.1.0/CHANGELOG.md

@@ -0,0 +1,97 @@
+# Changelog
+
+Notable changes to kemperrig, newest first.
+
+## v0.1.0 — 2026-10-04
+
+First public release. Apache-2.0; published to PyPI.
+
+### Reading
+
+- Opens a `.rmbackup`, the live Rig Manager directory, a dated snapshot (`Backups/*R2.db`)
+  or a rig or preset pack (`.rigpack`, `.presetpack`), told apart by content. Snapshot and
+  pack records have no folder; factory `ROMPresets` are not read.
+- Rigs (with `profile_type`, `profile_revision`, `cabinet_type` and
+  `cabinet_configuration` raw), performances and their slots, effect and cab-IR presets, and
+  backup info. A NULL name reads as empty, a non-BLOB payload as an empty payload, a BLOB in
+  a text column as NULL, and a `Gain` that is not a finite number as no gain. A damaged
+  database is reported with its path.
+- A damaged, encrypted or unsupported archive entry, or one that would inflate past 1 GiB or
+  past 100:1 beyond 16 MiB, is refused with a message naming it; `history` skips that file.
+- Payload decode for KThd/KTrk and MThd/MTrk framing: strings by address, amp gain from every
+  verified amp-block shape, the effect in each module slot with its on/off (REV on page
+  `0x3d`, or `0x4b` on older rigs), and the cab IR.
+- A module slot present only in the function-`08` framing is reported as undecoded — no
+  type, name or on/off — rather than dropped.
+- Effect type names and categories are read at runtime from the `Stomps.xml` in the user's
+  Rig Manager install; `KEMPERRIG_STOMPS_XML` overrides the path, and without it a verified
+  subset resolves.
+- A payload that is cut short, has a chunk running past its end or bytes after its last
+  chunk, or (for a performance) does not hold a header and five slot tracks does not parse.
+  Library-wide commands read past it and say so; a command about that one rig names it.
+
+### Commands
+
+- `summary`; `rigs` with metadata filters (`--name`, `--amp`, `--author`, `--folder`,
+  `--source`, `--channel`, `--comment`, `--gain-min`/`--gain-max`, `--di`/`--studio`,
+  `--boosted`/`--unboosted`); `rig`, narrowed by `--folder` or `--payload DIGEST`;
+  `presets`; `performances` with slot gain ladders and locked-effects share.
+- `rig --json` and `rigs --decode`: a rig's decoded amp gain, effects, cab IR and strings as
+  data. Every rig entry in `--json` carries its payload digest.
+- `--effect` and `--ir` select rigs by a decoded effect's type name or category and by cab-IR
+  name, on `rigs` and `extract`. Rigs a filter cannot judge are listed, never dropped.
+- `pages RIG` dumps a rig's raw parameter blocks; `pages --all` counts which pages occur
+  across the library.
+- `analyze` — orphaned rigs, per-amp gain coverage, duplicates, effect categories, cab-IR
+  usage, out-of-order gain ladders, payloads that do not parse. `--strict` exits 1 when there
+  is something to act on; `--rack-folder` exempts one folder from the orphan sweep.
+- `doctor` — dangling and ambiguous performance slots and broken payloads (definite);
+  unread payload bytes, gain and name disagreements and unused cab IRs (informational).
+  `--strict` exits 1 on a definite finding; `--device-backup` marks a slot whose rig is on
+  the device.
+- `shortlist` — caller-supplied amp patterns above a gain floor, DI-only unless
+  `--include-studio`; the criteria file is shape-checked on load.
+- `pack` lists a pack and its rigs or presets; `--against [LIBRARY]` marks each as in the
+  library, name taken, or new.
+- `diff` — rigs, performances and presets added, removed or changed, including a performance
+  slot re-pointed at another rig. Exits 1 when the sources differ.
+- `history` — per dated snapshot or backup, the counts and what changed since the previous
+  file from the same device; `--rig NAME` lists every file holding that rig and each payload
+  version.
+- `--json` on every read command, specified key by key in `docs/json.md`.
+
+### Writers — none modifies its source
+
+- `rename` writes a new archive with the rig renamed in its row, inside its payload, and in
+  each performance slot that loads it, keeping every other byte. It refuses an unknown name,
+  a taken one, and a new name that is not printable ASCII of at most 32 characters. Its
+  archive is not yet confirmed to restore into Rig Manager, and it says so.
+- `extract` writes selected rigs as standalone `.krig` files, verbatim. It requires a
+  selection or `--all`, and makes file names safe and numbers collisions.
+- `summary --write-golden PATH` writes a library census (format 1, with decoded and
+  undecoded effect slots counted apart) for the opt-in golden test.
+- All three refuse, exit 2, an output that is the source (case variants, symlinks, hardlinks
+  included), one inside the source or any Rig Manager library, and an existing output
+  without `--force`; missing folders on the way to the output are created. A file output
+  spelled as a folder (`out/`) is refused.
+
+### CLI
+
+- `KEMPERRIG_LIBRARY`, `KEMPERRIG_CRITERIA`, `KEMPERRIG_RACK_FOLDER` and
+  `KEMPERRIG_STOMPS_XML` supply the settings, and `--help` names each one.
+- Runs as `kemperrig`, `python -m kemperrig`, or `python -m kemperrig.cli`.
+- Every failure is a one-line message and a non-zero exit, never a traceback.
+- Text output shows control characters from a file as `\xNN`; `--json` is strict JSON.
+
+### Python API
+
+- `Backup.open` and the records, the services under `kemperrig.services`, and
+  `use_effect_names()` / `DEFAULT_STOMPS_XML` to name effects from Rig Manager's table.
+
+### Development
+
+- `bin/run sample DIR` writes a synthetic library — every source kind, one of each finding —
+  and the test suite runs every command against it.
+- Documentation in `docs/`: installation, capabilities, command reference, JSON reference,
+  Python API, criteria, census and format. `tests/test_docs.py` keeps the command and JSON
+  references in step with the code.

kemperrig-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,31 @@
+# Code of Conduct
+
+## Our standard
+
+kemperrig is a small, focused project. Everyone interacting in its issues, pull
+requests, and discussions is expected to be respectful and constructive.
+
+**Expected:** thoughtful feedback, good-faith disagreement, patience with
+newcomers, and keeping discussion technical.
+
+**Not tolerated:** harassment, personal attacks, demeaning or discriminatory
+comments, publishing others' private information, or sustained disruption.
+
+## Scope
+
+This applies in all project spaces — issues, pull requests, commit
+discussions, and any other official channel — and when representing the project
+in public spaces.
+
+## Reporting and enforcement
+
+Report unacceptable behavior privately to the project maintainer at
+**oss@phierceweb.com**. Reports will be handled discreetly. Maintainers may
+edit or remove contributions, and may warn or ban contributors, for behavior
+that violates this code.
+
+---
+
+For a more comprehensive document, this project is happy to adopt the
+[Contributor Covenant](https://www.contributor-covenant.org); the above is a
+concise statement of the same principles.

kemperrig-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing to kemperrig
+
+Bug reports, format findings, and fixes verified against real files are all welcome.
+
+## The property that matters
+
+kemperrig only reads. `.rmbackup` archives are the only copy of a profile library many people
+have, so nothing here modifies a source file. The three writers build new files — `rename` a
+new archive, `extract` standalone `.krig` files, `summary --write-golden` a JSON census —
+outside the source and any Rig Manager library, each behind a guard that starts from
+`model.write_refusal`. A change that writes in place will not be merged.
+
+## Setting up
+
+```bash
+git clone https://github.com/phierceweb/kemperrig && cd kemperrig
+bin/run setup               # venv + editable install with the dev tools
+bin/run pytest              # the suite
+bin/run lint                # ruff + the pf-core file-size gate
+.venv/bin/pre-commit install   # optional: run ruff and the gate on every commit
+```
+
+`bin/run` reads a gitignored `.env` for your own `KEMPERRIG_*` settings; see `.env.example`.
+
+## How the tests work
+
+Every test is hermetic. `tests/_payloads.py` builds real Kemper SysEx in KThd/KTrk chunks,
+`tests/_fixture.py` real `.rmbackup` archives and snapshots from them, and
+`tests/_pack_fixture.py` real packs — so nothing depends on a personal library, and nothing
+from one is ever committed.
+
+`tests/_sample.py` writes a whole synthetic library to disk: a backup, a live directory with
+two dated snapshots, a rig pack and a preset pack, and one of each thing `analyze` and
+`doctor` report. `tests/test_smoke.py` runs every command against it, and
+
+```bash
+bin/run sample /tmp/sample
+```
+
+writes one for you to try commands on by hand. When a change needs a case the sample lacks,
+extend the sample rather than reaching for a real file.
+
+One check is opt-in. With `KEMPERRIG_GOLDEN` naming a census written by
+`summary --write-golden` and `KEMPERRIG_LIBRARY` the library it describes,
+`tests/test_golden.py` compares the two field by field. Without both it skips; `bin/run
+pytest -rs` says why. See `docs/census.md`.
+
+`tests/test_docs.py` checks `docs/cli.md` and `docs/json.md` against the code, so a new
+command, flag or `--json` key needs its documentation in the same change.
+
+## Reporting a decode bug
+
+Rig Manager writes several generations of payload, and not all of them are understood. If
+a rig or performance decodes wrongly, please include the Rig Manager version, the Profiler
+model and OS version, the command you ran, and the value Rig Manager or the Profiler shows.
+**Do not attach the backup, a pack or a `.krig`** — they usually hold commercially licensed
+profiles, and an issue is public.
+
+## House rules
+
+- **Verify against a real file.** A decoding claim needs evidence: a value Rig Manager
+  displays, or a Profiler that agrees. A plausible-looking offset is not a finding; an
+  unverified value decodes to `None`.
+- **Keep the core dependency-light.** The standard library plus two pf-core helpers,
+  enforced by `tests/test_dependencies.py`. A new dependency needs a reason.
+- **Fixtures stay synthetic.** Never commit a real `.rmbackup` or pack, and never commit
+  identifying details from one — rig names, author handles, library counts.
+- **One-line errors.** Every CLI failure is one line on stderr and a non-zero exit, never a
+  traceback.
+- **File-size target 300 lines, hard limit 500**, one concern per file.
+- The rules behind these, and the layering they protect, are in `.ai/rules/`; `AGENTS.md`
+  is the short version.
+
+## License
+
+kemperrig is licensed under the Apache License, Version 2.0. By contributing, you agree
+that your contributions are licensed under the same terms.

kemperrig-0.1.0/LICENSE

@@ -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.

kemperrig-0.1.0/MANIFEST.in

@@ -0,0 +1,16 @@
+# setuptools' implicit sdist rules skip `tests/_*.py` fixtures and `config/`; the shipped
+# suite and the README's `--criteria` example need both.
+include MANIFEST.in
+include CHANGELOG.md CONTRIBUTING.md SECURITY.md CODE_OF_CONDUCT.md TRADEMARKS.md
+include .env.example
+recursive-include tests *.py
+recursive-include config *.json
+recursive-include docs *.md
+exclude .coverage
+prune .ai
+prune .claude
+prune .cursor
+prune .github
+
+# docs/pf-core is a gitignored symlink into site-packages; recursive-include follows it
+prune docs/pf-core

kemperrig-0.1.0/NOTICE

@@ -0,0 +1,13 @@
+kemperrig
+Copyright 2026 Mike Farr
+
+This product includes software developed by Mike Farr
+(https://github.com/phierceweb/kemperrig).
+
+Built on pf-core (https://github.com/phierceweb/pf-core), Copyright 2026 Mike Farr,
+licensed under the Apache License, Version 2.0.
+
+KEMPER, KEMPER PROFILER and RIG MANAGER are trademarks of Kemper GmbH. kemperrig is not
+affiliated with, endorsed by, or sponsored by Kemper GmbH, and contains no Kemper source
+code, firmware or documentation. See
+https://github.com/phierceweb/kemperrig/blob/main/TRADEMARKS.md.