pebble-shimmer 1.0.0__tar.gz

pebble_shimmer-1.0.0/.gitignore

@@ -0,0 +1,29 @@
+__pycache__
+/sandbox
+.idea
+*~
+.venv
+venv
+.vscode
+.coverage
+coverage.xml
+htmlcov
+/.tox
+.*.swp
+.ruff_cache
+
+# Tokens and settings for `act` to run GHA locally
+.env
+.envrc
+.secrets
+
+# Build artifacts
+/pebble-shimmer.egg-info
+/dist
+/build
+/docs/_build
+
+# Agents
+.claude/*local*
+
+/.workshop.lock

pebble_shimmer-1.0.0/CHANGELOG.md

@@ -0,0 +1,126 @@
+# 2026-06-05
+
+Shimmer 1.0.0. The `PebbleCliClient` API is now stable: it matches
+`ops.pebble.Client` method-for-method, return-type-for-return-type, and
+exception-for-exception, as exercised by `tests/integration/test_parity.py`.
+
+Features:
+
+- The `Development Status` classifier is now `5 - Production/Stable`.
+
+Bug fixes and packaging:
+
+- The source distribution now includes `CHANGELOG.md`.
+
+# 2026-05-31
+
+Features:
+
+- `push` and `pull` now work correctly with remote `Runner` implementations
+  (e.g. `JujuSshRunner`).  Runners that implement the new `FileTransferRunner`
+  protocol — three methods: `upload_temp`, `download_temp`, and `cleanup_temp`
+  — delegate temporary-file staging to the runner rather than assuming a shared
+  filesystem.  `LocalSubprocessRunner` implements `FileTransferRunner`, so
+  existing local-subprocess usage is unchanged.  `FileTransferRunner` is
+  exported from the top-level `shimmer` package.
+
+Bug fixes and packaging:
+
+- Python 3.14 is now officially supported and tested.
+
+# 2026-05-28
+
+Features:
+
+- `PebbleCliClient` now accepts an optional `runner=` keyword argument on
+  construction. The `Runner` protocol (two methods: `run` and `popen`,
+  mirroring `subprocess.run` / `subprocess.Popen`) lets callers swap out how
+  the `pebble` binary is invoked — for example, by prefixing the argv with
+  `juju ssh --container=<c> <unit> --` to drive a remote Pebble. The default
+  behaviour is unchanged: when `runner` is omitted, `LocalSubprocessRunner`
+  is used, which reproduces the previous local-subprocess behaviour
+  byte-for-byte. Both `Runner` and `LocalSubprocessRunner` are exported from
+  the top-level `shimmer` package.
+
+`get_notices()` and `get_notice()` now use Pebble's structured `--format json`
+output instead of scraping the human-readable table and parsing per-notice
+YAML. `get_notices()` reads every matching notice in a single call (it no
+longer makes a follow-up call per notice).
+
+Bug fixes and packaging:
+
+- `get_notices(types=...)` now filters correctly. It previously passed the
+  type as a positional argument, which newer Pebble rejects with "too many
+  arguments"; types are now passed via the `--type` flag.
+
+# 2026-05-22
+
+Features:
+
+Use Pebble's structured `--format json` output for read commands
+(`get_services`, `get_checks`, `list_files`, `get_changes`, `get_change`,
+`get_identities`). This is more robust than scraping human-readable tables and
+restores information the text parser had to drop or guess: change `kind`,
+`tasks` and `err`; check `successes`/`failures`/`threshold`/`change_id`; real
+file `user_id`/`group_id`/`size`/`type`; and identity local `user_id`.
+
+Requires a Pebble build that supports `--format` on read commands.
+
+Bug fixes and packaging:
+
+- `get_warnings()` now correctly returns an empty list when there are no
+  warnings (it previously always raised `NotImplementedError`).
+- `notify()` raises `ValueError` (instead of `assert`-ing) for non-custom
+  notice types, and renders `repeat_after` as a valid Pebble duration string.
+- `socket_path` now also sets the `PEBBLE_SOCKET` environment variable, as
+  documented.
+- The pebble exception types (`Error`, `APIError`, `ChangeError`,
+  `ConnectionError`, `ExecError`, `PathError`, `ProtocolError`, `TimeoutError`)
+  can now be imported directly from `shimmer` (e.g. `from shimmer import
+  APIError`); previously they had to be imported from `ops.pebble`.
+- `get_notice()` and `get_notices()` now return correctly-typed `Notice`
+  objects (real `last_occurred`/`last_data`/`expire_after`) parsed from
+  Pebble's per-ID YAML. `get_notice(id)` previously returned the wrong notice
+  or raised `IndexError`.
+- `send_signal()` accepts bare signal names (e.g. `"HUP"`) in addition to the
+  `"SIGHUP"` form, matching `ops.pebble.Client`; invalid names raise
+  `ValueError`.
+- `ExecProcess.wait()` no longer deadlocks when a process emits more than the
+  OS pipe buffer (~64KB) before exiting, and now feeds `stdin`. It is
+  reimplemented in terms of `communicate()`.
+- Ship a `py.typed` marker so downstream type checkers use Shimmer's types.
+- `__version__` is derived from the installed package metadata.
+- `APIError` raised on a CLI failure now mirrors `ops.pebble.Client`: `code`
+  is the inferred HTTP status (e.g. `404` for not-found, `400` for bad
+  requests) instead of the process exit code, `status` is the matching reason
+  phrase, `message` drops the CLI's `error:` prefix so it matches the daemon's
+  message verbatim, and `body` uses Pebble's wire format
+  (`{"type": "error", "status-code": ..., "result": {"message": ...}}`).
+  Errors that can't be classified fall back to `500`. Code that branches on
+  `APIError.code` (e.g. `== 404`) now works portably across both clients.
+- `abort_change()` now exists on `PebbleCliClient`, so the client implements
+  the full `ops.pebble.Client` surface (and its own `PebbleClientProtocol`).
+  The Pebble CLI exposes no command to abort a change, so it raises a clear
+  `NotImplementedError` explaining the limitation instead of failing with
+  `AttributeError`.
+- `pull()` now returns a file handle that streams from disk instead of
+  buffering the whole file into an in-memory `io.StringIO`/`io.BytesIO`. This
+  matches `ops.pebble.Client.pull` (which also returns an open file object over
+  an unlinked temp file), so large files no longer require a full extra copy in
+  memory. The return value is still a readable text/binary file object.
+
+# 2025-07-25
+
+Add missing overloads on pull() and exec().
+
+# 2025-07-21
+
+Add get_change().
+
+# 2025-07-20
+
+Allow Python 3.11.
+
+# 2025-07-12
+
+Initial alpha version.

pebble_shimmer-1.0.0/LICENSE

@@ -0,0 +1,203 @@
+
+                                 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.
+   

pebble_shimmer-1.0.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: pebble-shimmer
+Version: 1.0.0
+Summary: A drop-in replacement for ops.pebble.Client that uses the Pebble CLI
+Project-URL: Homepage, https://github.com/tonyandrewmeyer/shimmer
+Project-URL: Repository, https://github.com/tonyandrewmeyer/shimmer
+Project-URL: Documentation, https://github.com/tonyandrewmeyer/shimmer#readme
+Project-URL: Bug Tracker, https://github.com/tonyandrewmeyer/shimmer/issues
+Author-email: Tony Meyer <shimmer@aotearoa.dev>
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.11
+Requires-Dist: ops<4,>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# Shimmer — a shiny Pebble client
+
+A 100% compatible, drop-in replacement for `ops.pebble.Client` that drives
+[Pebble](https://documentation.ubuntu.com/pebble) through its **CLI** instead of
+the unix socket — for environments where the socket isn't reachable (such as a
+Rock or a Juju container).
+
+![Shimmer parity demo](https://raw.githubusercontent.com/tonyandrewmeyer/shimmer/main/demo.gif)
+
+<sub>The same deploy-and-verify routine run over `ops.pebble.Client` (unix
+socket, left) and `shimmer.PebbleCliClient` (CLI, right) — identical results.</sub>
+
+## Overview
+
+`PebbleCliClient` implements the same interface as `ops.pebble.Client`: same
+method signatures, same return types, same raised exceptions. Under the hood it
+translates each call into a `pebble` CLI command, parses the output back into the
+same Python objects `ops` returns, and maps CLI errors onto the matching
+exceptions. The contract is **parity** — code written against `ops.pebble.Client`
+should run unchanged against Shimmer.
+
+## Installation
+
+```bash
+# From PyPI
+uv pip install pebble-shimmer
+
+# Development version
+git clone https://github.com/tonyandrewmeyer/shimmer
+cd shimmer
+uv pip install -e .
+```
+
+## Usage
+
+Construct the client, then use it exactly like `ops.pebble.Client` — the methods,
+arguments, return types, and exceptions are the same:
+
+```python
+from shimmer import PebbleCliClient as Client
+
+client = Client()
+client.replan_services()
+for service in client.get_services():
+    print(service.name, service.current.value)
+```
+
+The whole point is that there's nothing new to learn: the full method surface is
+documented by [`ops.pebble.Client`](https://ops.readthedocs.io/en/latest/reference/pebble.html).
+Swapping `ops.pebble.Client` for `shimmer.PebbleCliClient` is the only change.
+
+The constructor is where Shimmer differs, since it talks to a binary rather than
+a socket:
+
+```python
+client = Client(
+    socket_path="/var/lib/pebble/default/.pebble.socket",  # sets PEBBLE / PEBBLE_SOCKET
+    pebble_binary="/snap/bin/pebble",  # path to the pebble binary (default: "pebble")
+    timeout=5.0,  # default per-command timeout in seconds
+)
+```
+
+`socket_path` doesn't open a socket — it points Shimmer at the daemon by setting
+`PEBBLE` (its parent directory) and `PEBBLE_SOCKET` for the CLI. For drop-in
+parity the constructor also accepts `opener` and `base_url`, but those only
+configure the socket transport, so Shimmer accepts and ignores them. The
+`ops.pebble` exceptions are re-exported from `shimmer` for convenience, but they
+are the same objects, so `except ops.pebble.APIError` keeps working too.
+
+## Demo and verification
+
+The GIF above is a recording of [`demo.md`](demo.md) — a
+[Showboat](https://pypi.org/project/showboat/) document that runs one
+deploy-and-verify routine against the **real socket client**, then the **same
+code** against Shimmer, and `diff`s the two outputs to prove they're identical.
+It's reproducible:
+
+```bash
+uv run python demo.py            # rebuild demo.md (verifies parity live)
+uv run python demo.py --record   # re-record demo.cast (needs tmux + asciinema)
+agg demo.cast demo.gif           # regenerate the GIF from the cast
+```
+
+Parity is also exercised in CI by `tests/integration/test_parity.py`, which runs
+the same operations through both clients and asserts equal results.
+
+## Limitations and parity notes
+
+CLI invocation is the source of every limitation here — each call spawns a
+`pebble` process, so there's more per-call overhead than the socket transport,
+and some streaming is buffered rather than incremental.
+
+A few methods can't fully match the socket client:
+
+- `replan_services()`, `start_services()`, `stop_services()`, and
+  `restart_services()` return the change ID only when no timeout is set.
+- `notify()` supports custom notices only (Pebble's CLI only exposes
+  `pebble notify` for custom notices).
+- `abort_change()` raises `NotImplementedError`: the Pebble CLI exposes no
+  command to abort a change, so there is no way to back this through the CLI.
+- `get_warnings()` and `ack_warnings()` raise `NotImplementedError`: warnings
+  are deprecated in Pebble (the warnings API has been removed and warnings are
+  now surfaced as notices). Use `get_notices()` / `get_notice()` instead.
+
+`get_services()`, `get_checks()`, `list_files()`, `get_changes()`,
+`get_change()`, and `get_identities()` use Pebble's structured `--format json`
+output, so they return the same rich data as `ops.pebble.Client` (change
+`kind`/`tasks`/`err`, check thresholds, real file ownership, local identity user
+IDs). This requires a Pebble build that supports `--format` on read commands.
+
+## Comparison with `ops.pebble.Client`
+
+| | `ops.pebble.Client` | `PebbleCliClient` |
+|---|---|---|
+| Transport | Unix socket | `pebble` CLI |
+| Requires | Socket access | `pebble` binary |
+| Performance | Higher | Moderate (per-call process spawn) |
+| API | Native | 100% compatible |
+
+## Troubleshooting
+
+**`Pebble binary not found`** — pass the full path:
+`Client(pebble_binary="/snap/bin/pebble")`.
+
+**`Connection error`** — confirm the daemon is up and `PEBBLE` points at its home
+directory (or pass `socket_path=`); check `pebble version`.
+
+**See the commands Shimmer runs** — enable debug logging:
+
+```python
+import logging
+logging.basicConfig(level=logging.DEBUG)
+```
+
+## More
+
+- [CONTRIBUTING.md](CONTRIBUTING.md) — contribution guidelines
+- [CHANGELOG.md](CHANGELOG.md) — version history
+- Related: [ops](https://ops.readthedocs.io) ·
+  [pebble](https://documentation.ubuntu.com/pebble) · [juju](https://juju.is) ·
+  [charmcraft](https://canonical-charmcraft.readthedocs-hosted.com) ·
+  [rockcraft](https://documentation.ubuntu.com/rockcraft)

pebble_shimmer-1.0.0/README.md

@@ -0,0 +1,142 @@
+# Shimmer — a shiny Pebble client
+
+A 100% compatible, drop-in replacement for `ops.pebble.Client` that drives
+[Pebble](https://documentation.ubuntu.com/pebble) through its **CLI** instead of
+the unix socket — for environments where the socket isn't reachable (such as a
+Rock or a Juju container).
+
+![Shimmer parity demo](https://raw.githubusercontent.com/tonyandrewmeyer/shimmer/main/demo.gif)
+
+<sub>The same deploy-and-verify routine run over `ops.pebble.Client` (unix
+socket, left) and `shimmer.PebbleCliClient` (CLI, right) — identical results.</sub>
+
+## Overview
+
+`PebbleCliClient` implements the same interface as `ops.pebble.Client`: same
+method signatures, same return types, same raised exceptions. Under the hood it
+translates each call into a `pebble` CLI command, parses the output back into the
+same Python objects `ops` returns, and maps CLI errors onto the matching
+exceptions. The contract is **parity** — code written against `ops.pebble.Client`
+should run unchanged against Shimmer.
+
+## Installation
+
+```bash
+# From PyPI
+uv pip install pebble-shimmer
+
+# Development version
+git clone https://github.com/tonyandrewmeyer/shimmer
+cd shimmer
+uv pip install -e .
+```
+
+## Usage
+
+Construct the client, then use it exactly like `ops.pebble.Client` — the methods,
+arguments, return types, and exceptions are the same:
+
+```python
+from shimmer import PebbleCliClient as Client
+
+client = Client()
+client.replan_services()
+for service in client.get_services():
+    print(service.name, service.current.value)
+```
+
+The whole point is that there's nothing new to learn: the full method surface is
+documented by [`ops.pebble.Client`](https://ops.readthedocs.io/en/latest/reference/pebble.html).
+Swapping `ops.pebble.Client` for `shimmer.PebbleCliClient` is the only change.
+
+The constructor is where Shimmer differs, since it talks to a binary rather than
+a socket:
+
+```python
+client = Client(
+    socket_path="/var/lib/pebble/default/.pebble.socket",  # sets PEBBLE / PEBBLE_SOCKET
+    pebble_binary="/snap/bin/pebble",  # path to the pebble binary (default: "pebble")
+    timeout=5.0,  # default per-command timeout in seconds
+)
+```
+
+`socket_path` doesn't open a socket — it points Shimmer at the daemon by setting
+`PEBBLE` (its parent directory) and `PEBBLE_SOCKET` for the CLI. For drop-in
+parity the constructor also accepts `opener` and `base_url`, but those only
+configure the socket transport, so Shimmer accepts and ignores them. The
+`ops.pebble` exceptions are re-exported from `shimmer` for convenience, but they
+are the same objects, so `except ops.pebble.APIError` keeps working too.
+
+## Demo and verification
+
+The GIF above is a recording of [`demo.md`](demo.md) — a
+[Showboat](https://pypi.org/project/showboat/) document that runs one
+deploy-and-verify routine against the **real socket client**, then the **same
+code** against Shimmer, and `diff`s the two outputs to prove they're identical.
+It's reproducible:
+
+```bash
+uv run python demo.py            # rebuild demo.md (verifies parity live)
+uv run python demo.py --record   # re-record demo.cast (needs tmux + asciinema)
+agg demo.cast demo.gif           # regenerate the GIF from the cast
+```
+
+Parity is also exercised in CI by `tests/integration/test_parity.py`, which runs
+the same operations through both clients and asserts equal results.
+
+## Limitations and parity notes
+
+CLI invocation is the source of every limitation here — each call spawns a
+`pebble` process, so there's more per-call overhead than the socket transport,
+and some streaming is buffered rather than incremental.
+
+A few methods can't fully match the socket client:
+
+- `replan_services()`, `start_services()`, `stop_services()`, and
+  `restart_services()` return the change ID only when no timeout is set.
+- `notify()` supports custom notices only (Pebble's CLI only exposes
+  `pebble notify` for custom notices).
+- `abort_change()` raises `NotImplementedError`: the Pebble CLI exposes no
+  command to abort a change, so there is no way to back this through the CLI.
+- `get_warnings()` and `ack_warnings()` raise `NotImplementedError`: warnings
+  are deprecated in Pebble (the warnings API has been removed and warnings are
+  now surfaced as notices). Use `get_notices()` / `get_notice()` instead.
+
+`get_services()`, `get_checks()`, `list_files()`, `get_changes()`,
+`get_change()`, and `get_identities()` use Pebble's structured `--format json`
+output, so they return the same rich data as `ops.pebble.Client` (change
+`kind`/`tasks`/`err`, check thresholds, real file ownership, local identity user
+IDs). This requires a Pebble build that supports `--format` on read commands.
+
+## Comparison with `ops.pebble.Client`
+
+| | `ops.pebble.Client` | `PebbleCliClient` |
+|---|---|---|
+| Transport | Unix socket | `pebble` CLI |
+| Requires | Socket access | `pebble` binary |
+| Performance | Higher | Moderate (per-call process spawn) |
+| API | Native | 100% compatible |
+
+## Troubleshooting
+
+**`Pebble binary not found`** — pass the full path:
+`Client(pebble_binary="/snap/bin/pebble")`.
+
+**`Connection error`** — confirm the daemon is up and `PEBBLE` points at its home
+directory (or pass `socket_path=`); check `pebble version`.
+
+**See the commands Shimmer runs** — enable debug logging:
+
+```python
+import logging
+logging.basicConfig(level=logging.DEBUG)
+```
+
+## More
+
+- [CONTRIBUTING.md](CONTRIBUTING.md) — contribution guidelines
+- [CHANGELOG.md](CHANGELOG.md) — version history
+- Related: [ops](https://ops.readthedocs.io) ·
+  [pebble](https://documentation.ubuntu.com/pebble) · [juju](https://juju.is) ·
+  [charmcraft](https://canonical-charmcraft.readthedocs-hosted.com) ·
+  [rockcraft](https://documentation.ubuntu.com/rockcraft)