logicxkit 0.1.0__tar.gz

logicxkit-0.1.0/.env.example

@@ -0,0 +1,44 @@
+# Copy to .env (gitignored). All are optional — each has a working default.
+# macOS only: the tools read and write Logic Pro's own files, the Swift helpers under
+# src/logicxkit/native/ run through the `swift` toolchain, and `logic ocr` uses Apple Vision.
+
+# X32 scene file for the tests/rig preflight golden. Absent -> those tests skip.
+LOGICXKIT_SCENE="$HOME/Music/Behringer/x32/Scenes/example.scn"
+
+# Names the goldens build their paths from: the two channel-strip library folders and the
+# prefix on the .logicx templates. The files themselves are not in this repo, so a golden
+# whose file is missing skips. The values below are placeholders — use your own.
+LOGICXKIT_STRIP_LIB="Example Mixing"
+LOGICXKIT_TRACK_LIB="Example Tracking"
+LOGICXKIT_PROJECT_PREFIX="Example"
+
+# Logic's own user folder, the base for both settings libraries.
+# Absent -> ~/Music/Audio Music Apps.
+LOGICXKIT_AUDIO_MUSIC_APPS=
+
+# Root for a spec's relative strip paths, and where `logic diff --library` looks.
+# Absent -> Logic's own ~/Music/Audio Music Apps/Channel Strip Settings, which is what you
+# want for real use; the tests fall back to a staged snapshot under resources/ instead of the
+# live library (see resources/README.md — those files are not in the repo). Leave it unset
+# unless you keep your strips somewhere else.
+LOGICXKIT_STRIP_ROOT=
+# Read Logic's settings from a copy instead of ~/Library/Preferences. Absent -> Logic's own.
+LOGICXKIT_LOGIC_PREFS=
+# Logic.app itself, for the factory .pst defaults. Absent -> /Applications/Logic Pro.app.
+LOGICXKIT_LOGIC_APP=
+
+# Root of a rig config tree kept outside this repo: the tests/rig preflight golden reads
+# <root>/x32/preflight.json. Absent -> ~/.config/logicxkit/rig; missing -> those tests skip.
+LOGICXKIT_RIG_CONFIG="$HOME/.config/logicxkit/rig"
+# Logic-written record templates, donor slots and AU tables. Written by Logic and by plugin
+# vendors, so they are not in the repo — see resources/data/README.md for how to make them.
+LOGICXKIT_DATA=resources/data
+# --- test-only ---
+# Reference corpus the goldens read. Absent -> resources/ beside this file; the files are not
+# in the repo (see resources/README.md), so the goldens skip when it is empty.
+LOGICXKIT_RESOURCES=
+# Project templates within that corpus. Absent -> <resources>/templates.
+LOGICXKIT_TEMPLATES=
+# Set to 1 to turn a golden whose file is missing into a failure instead of a skip. Every run
+# prints `goldens: N of M keys found`; this is how you stop N from quietly being 0.
+LOGICXKIT_REQUIRE_GOLDENS=

logicxkit-0.1.0/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+Notable changes to logicxkit. Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/);
+versions follow [semantic versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.1.0 — 2026-09-10
+
+First public release.
+
+### Added
+
+- `logicxkit logic` — Logic Pro channel-strip (`.cst`) build and decode, read-only `.logicx`
+  project analysis, and writers for the track list, stacks, groups, sends, routing, channel
+  levels and width, arrangement, tempo, time and key signatures, transport modes, metronome,
+  track headers, control bar, toolbar and Logic's own settings. Every project-mutating command
+  requires `--out` and works on a copy.
+- `logicxkit logic apply-template` — migrate a session onto a template, pairing by Environment
+  object id within a lineage and by an explicit map across lineages.
+- `logicxkit logic diff` — project-to-project and project-to-strip-library drift.
+- `logicxkit logic image` / `ocr` — extract and OCR the auto-saved WindowImage via Apple Vision.
+- `logicxkit au` — Audio Unit preset and state decode: FabFilter `.ffp` and `.aupreset`, Waves
+  XPst, TR5 chain XML, sonible protobuf field walk, and the third-party states embedded in
+  `.cst` strips and `.logicx` projects.
+- Headless AU host (`auprobe.swift`) — loads an installed plugin's state and dumps every
+  parameter with real names and UI-formatted values.
+- `logicxkit logic capabilities` — what each command is trusted for, generated from
+  `logic/_capabilities.py`.
+- `logicxkit --version` (`-V`) prints the installed version.
+- Write gate (`logic/services/integrity.py`): every project write is held against its input and
+  refused on any regression; a refused run discards the copy.
+- A write by a command whose capability level is `CLAIMED`, `DERIVED` or `BROKEN` prints a
+  one-line notice naming that level (`LOGICXKIT_NO_NOTICE=1` silences it).
+- `logic transplant` refuses a clone that overruns the channel's slot key range or crosses a
+  record class version; `--force` overrides.
+- `logic build` and `logic pst` refuse to write into Logic's own library unless `--install` is
+  passed.
+- Strip specs take `output_root`, which moves where built strips land without moving where
+  their sources are read from.
+- CI on a macOS runner; `v*` tags build an sdist + wheel, check the wheel carries the Swift
+  helpers and no reference material, and publish to PyPI through a trusted publisher gated on
+  reviewer approval.

logicxkit-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Code of Conduct
+
+## Our pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a
+harassment-free experience for everyone, regardless of age, body size, visible or invisible
+disability, ethnicity, sex characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race, caste, colour,
+religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive,
+and healthy community.
+
+## Our standards
+
+Examples of behaviour that contributes to a positive environment:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologising to those affected by our mistakes
+- Focusing on what is best for the overall community
+
+Examples of unacceptable behaviour:
+
+- The use of sexualised language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address, without their
+  explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the
+project maintainers by opening a report through
+[GitHub's private reporting](https://github.com/phierceweb/logicxkit/security/advisories/new)
+or by contacting the maintainer through their GitHub profile. All complaints will be reviewed
+and investigated promptly and fairly. Maintainers are obligated to respect the privacy and
+security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1, available at
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

logicxkit-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Contributing
+
+## Requirements
+
+macOS with Logic Pro, Python 3.12, and a `swift` toolchain. There is no Linux path. CI runs
+lint and the suite on a macOS runner, but a runner has no reference corpus and no console, so
+the goldens and `tests/rig` skip there and a green check proves the synthetic layer only.
+`bin/run lint && bin/run pytest` on your own machine, before you open a pull request, is still
+the gate — and if you have the corpus staged, say so in the PR, because that run is worth more
+than the runner's.
+
+## Setup
+
+```bash
+bin/run setup
+bin/run pytest
+bin/run lint
+```
+
+`bin/run setup rig` additionally installs `x32scene`, which only `tests/rig` needs.
+
+## What a green suite does and does not prove
+
+Tests that read real Logic files skip when those files are absent, and they are absent in every
+clone — the reference corpus is not distributed. Every run ends with a
+`goldens: N of M keys found` line; on a machine without the corpus it reads `0 of M` and the
+suite is still green. Set `LOGICXKIT_REQUIRE_GOLDENS=1` to make a missing golden fail instead.
+See `resources/README.md` and `resources/data/README.md` for what the corpus is and how to
+build your own.
+
+## Evidence
+
+A claim about byte layout needs a real file behind it. `None` beats a guess, and a command's
+confidence level in `logic/_capabilities.py` may only be raised by evidence the level names:
+
+- **CONFIRMED** — the output was opened in Logic and the change was there.
+- **DERIVED** — reasoned from reads and diffs; never opened in Logic.
+- **CLAIMED** — was confirmed once, but the artifact is gone or the code has changed since.
+
+A file that opens in Logic can still be wrong. The way to check a writer is Save As in Logic and
+diff the record list against the input.
+
+## House rules
+
+- File size: 300 lines is the target, 500 is the hard limit enforced by `bin/run lint`. There is
+  no baseline file — split the file instead.
+- One concern per file. `src/logicxkit/au` must never import `src/logicxkit/logic`; both read
+  Logic containers through `src/logicxkit/logicx`. `tests/test_package_layering.py` enforces it.
+- `X | None` types, src-layout, no `sys.path` hacks.
+- Comments carry the non-obvious why, an invariant, or a trap — not what the code already says,
+  and not history.
+- Tests travel with the change.
+
+## Licensing of contributions
+
+logicxkit is Apache-2.0. Under section 5 of that licence, anything you deliberately submit for
+inclusion is contributed under the same terms. There is no separate CLA.

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

logicxkit-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+# distutils' sdist default globs `tests/test*.py`: top level only, and only names starting with
+# `test`. conftest.py and the `_*.py` helpers it imports are left behind, so the tree cannot collect.
+recursive-include tests *.py
+# test_capabilities.py reads these two; without them the shipped suite fails rather than skips.
+recursive-include docs *.md
+recursive-include config *.json
+include CHANGELOG.md CONTRIBUTING.md CODE_OF_CONDUCT.md .env.example
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

logicxkit-0.1.0/NOTICE

@@ -0,0 +1,16 @@
+logicxkit
+Copyright 2026 Mike Farr
+
+This product includes software developed by Mike Farr.
+
+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
+
+"Logic Pro", "Audio Units" and "Apple" are trademarks of Apple Inc. Other product
+and plug-in names are the trademarks of their respective owners. This project is
+not affiliated with, endorsed by, or sponsored by Apple Inc. or any plug-in vendor;
+their names appear only to identify the file formats and products this software
+reads.