pebble-shimmer 1.0.0a1__tar.gz

pebble_shimmer-1.0.0a1/.gitignore

@@ -0,0 +1,24 @@
+__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

pebble_shimmer-1.0.0a1/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.0a1/PKG-INFO

@@ -0,0 +1,399 @@
+Metadata-Version: 2.4
+Name: pebble-shimmer
+Version: 1.0.0a1
+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 :: 3 - Alpha
+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.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.12
+Requires-Dist: ops<4,>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.10.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: tox>=4.0.0; extra == 'dev'
+Requires-Dist: ty; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Shimmer - shiny Pebble client
+
+A 100% compatible drop-in replacement for `ops.pebble.Client` that uses the Pebble CLI tool instead of socket communication.
+
+## Overview
+
+Shimmer provides `PebbleCliClient`, a class that implements the same interface as `ops.pebble.Client` but communicates with Pebble via CLI commands instead of socket communication. This is useful for environments with restricted socket access (such as a Rock or Juju container).
+
+## Installation
+
+### Install from PyPI
+
+```bash
+uv pip install shimmer
+```
+
+### Install development version
+```bash
+git clone https://github.com/tonyandrewmeyer/shimmer
+cd shimmer
+uv pip install -e .
+```
+
+## Quick Start
+
+```python
+from shimmer import PebbleCliClient as Client
+
+# Create a client instance:
+client = Client(
+    socket_path="/var/lib/pebble/default/.pebble.socket",  # Optional: for env setup
+    pebble_binary="pebble",  # Path to pebble binary
+    timeout=30.0,  # Default command timeout
+)
+
+# Use exactly like ops.pebble.Client:
+services = client.get_services()
+client.start_services(["myservice"])
+
+# Execute commands:
+process = client.exec(["echo", "hello world"])
+stdout, stderr = process.wait_output()
+print(stdout)  # "hello world\n"
+
+# File operations:
+client.push("/path/to/file", "content")
+content = client.pull("/path/to/file").read()
+
+# Layer management
+layer = """
+services:
+  myservice:
+    override: replace
+    command: python3 -m http.server 8080
+    startup: enabled
+"""
+client.add_layer("mylayer", layer)
+client.replan_services()
+```
+
+## Advanced Usage
+
+### Custom Binary Path
+
+```python
+client = PebbleCliClient(pebble_binary="/usr/local/bin/pebble")
+```
+
+### Environment Configuration
+
+```python
+# If using custom Pebble directory:
+client = PebbleCliClient(socket_path="/custom/path/.pebble.socket")
+
+# This automatically sets:
+# PEBBLE=/custom/path
+# PEBBLE_SOCKET=/custom/path/.pebble.socket
+```
+
+### Error Handling
+
+```python
+from shimmer import APIError, ConnectionError, TimeoutError
+
+try:
+    client.start_services(["nonexistent"])
+except APIError as e:
+    print(f"API Error: {e.message} (code: {e.code})")
+except ConnectionError:
+    print("Could not connect to Pebble")
+except TimeoutError:
+    print("Operation timed out")
+```
+
+### Process Execution
+
+```python
+# Simple command:
+process = client.exec(["ls", "-la"])
+stdout, stderr = process.wait_output()
+
+# With environment and options:
+process = client.exec(
+    ["python3", "script.py"],
+    environment={"PYTHONPATH": "/app"},
+    working_dir="/app",
+    timeout=60.0,
+    user="appuser",
+)
+
+# Streaming I/O:
+process = client.exec(["cat"], stdin="Hello World\n")
+stdout, stderr = process.wait_output()
+```
+
+## Architecture
+
+The `PebbleCliClient` works by:
+
+1. **Command Translation** - Converts API calls to CLI commands
+2. **Output Parsing** - Parses CLI output back to Python objects
+3. **Error Mapping** - Maps CLI errors to compatible exceptions
+4. **Process Management** - Handles subprocess execution and I/O
+
+## Limitations
+
+While this client aims for 100% compatibility, there are some limitations due to CLI constraints:
+
+1. **Performance** - CLI calls have higher overhead than socket communication
+2. **Concurrency** - Each operation spawns a new process
+3. **Streaming** - Some streaming operations may be buffered
+4. **Platform** - Requires Pebble binary in PATH or specified location
+
+Other minor limitations:
+
+- `replan_services()`, `start_services()`, `stop_services()`, and `restart_services()` are only able to return the change ID if no timeout is set.
+- `notify()` only supports custom notices.
+- `get_notices()` cannot include the `last_occurred`, `last_data`, `repeat_after`, or `expire_after` fields
+- `get_changes()` cannot include the `kind`, `tasks`, `err`, `ready_time`, or `data` fields, and guesses at the `ready` field
+- `autostart_services()` is an alias for `replan()` (possibly we could fix this by getting the current state?)
+- `wait_change()` is yet to be implemented
+- `ack_warnings()` is yet to be implemented
+- `get_warnings()` is only implemented for the 'no warnings' case
+- `list_file()` looks up the user and group IDs locally, which is very likely to be wrong
+- `get_identities()` is unable to get the user ID for local identities
+
+## Comparison with ops.pebble.Client
+
+| Feature | ops.pebble.Client | PebbleCliClient |
+|---------|------------------|-----------------|
+| Communication | Unix socket | CLI commands |
+| Performance | High | Moderate |
+| Setup | Requires socket access | Requires binary |
+| Compatibility | Native | 100% API compatible |
+| Dependencies | ops library | ops library + CLI |
+| Use Cases | Production charms | Testing, development, debugging |
+
+## Examples
+
+### Service Management
+
+```python
+from shimmer import PebbleCliClient as Client
+
+client = Client()
+
+# Get all services:
+services = client.get_services()
+for service in services:
+    print(f"{service.name}: {service.current}")
+
+# Start specific services:
+change_id = client.start_services(["web", "db"])
+print(f"Started services, change: {change_id}")
+
+# Wait for change to complete:
+change = client.wait_change(change_id)
+print(f"Change {change.id} status: {change.status}")
+```
+
+### File Management
+
+```python
+# Create directory structure:
+client.make_dir("/app/config", make_parents=True, permissions=0o755)
+
+# Write configuration file:
+config = """
+server:
+  port: 8080
+  host: 0.0.0.0
+"""
+client.push("/app/config/server.yaml", config)
+
+# Read file back:
+content = client.pull("/app/config/server.yaml").read()
+print(content)
+
+# List directory contents:
+files = client.list_files("/app/config")
+for file in files:
+    print(f"{file.name} ({file.type})")
+```
+
+### Layer Management
+
+```python
+# Define service layer:
+layer = {
+    "summary": "Web application layer",
+    "description": "Defines the web application service",
+    "services": {
+        "webapp": {
+            "override": "replace",
+            "summary": "Web application",
+            "command": "python3 -m uvicorn app:main --host 0.0.0.0 --port 8080",
+            "startup": "enabled",
+            "environment": {
+                "PYTHONPATH": "/app"
+            },
+            "user": "webapp",
+            "group": "webapp",
+        }
+    },
+    "checks": {
+        "webapp-health": {
+            "override": "replace",
+            "level": "alive",
+            "http": {"url": "http://localhost:8080/health"},
+            "period": "10s",
+            "timeout": "3s",
+            "threshold": 3,
+        }
+    }
+}
+
+# Add and apply layer:
+client.add_layer("webapp", layer)
+change_id = client.replan_services()
+
+# Wait for services to start:
+client.wait_change(change_id)
+
+# Check service status:
+services = client.get_services(["webapp"])
+print(f"webapp status: {services[0].current}")
+```
+
+### Command Execution
+
+```python
+# Execute simple command:
+process = client.exec(["whoami"])
+stdout, stderr = process.wait_output()
+print(f"Running as: {stdout.strip()}")
+
+# Execute with service context:
+process = client.exec(
+    ["python3", "-c", "import os; print(os.getcwd())"],
+    service_context="webapp"
+)
+stdout, stderr = process.wait_output()
+print(f"Service working directory: {stdout.strip()}")
+
+# Execute interactive command:
+process = client.exec(["python3", "-c", "print(input('Name: '))"])
+process.stdin.write("Alice\n")
+process.stdin.close()
+stdout, stderr = process.wait_output()
+print(f"Output: {stdout.strip()}")
+```
+
+### Health Checks
+
+```python
+# Get all checks:
+checks = client.get_checks()
+for check in checks:
+    print(f"{check.name}: {check.status} ({check.level})")
+
+# Start specific checks:
+started = client.start_checks(["webapp-health"])
+print(f"Started checks: {started}")
+
+# Monitor check status:
+import time
+for _ in range(5):
+    checks = client.get_checks(names=["webapp-health"])
+    if checks:
+        check = checks[0]
+        print(f"Check status: {check.status}, failures: {check.failures}")
+    time.sleep(2)
+```
+
+### Notice Management
+
+```python
+# Get recent notices:
+notices = client.get_notices()
+for notice in notices:
+    print(f"{notice.type}: {notice.key} (occurred: {notice.occurrences})")
+
+# Create custom notice:
+notice_id = client.notify(
+    type="custom",
+    key="myapp.com/deployment",
+    data={"version": "1.2.3", "environment": "production"}
+)
+print(f"Created notice: {notice_id}")
+
+# Get specific notice:
+notice = client.get_notice(notice_id)
+print(f"Notice data: {notice.last_data}")
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **"Pebble binary not found"**
+   ```python
+   # Specify full path to pebble
+   client = PebbleCliClient(pebble_binary="/snap/bin/pebble")
+   ```
+
+2. **"Permission denied"**
+   ```bash
+   # Ensure user has access to Pebble directory
+   sudo chown -R $USER:$USER $PEBBLE
+   ```
+
+3. **"Connection error"**
+   ```python
+   # Check if Pebble is running
+   import subprocess
+   result = subprocess.run(["pebble", "version"], capture_output=True)
+   print(result.stdout)
+   ```
+
+### Debugging
+
+Enable debug logging to see CLI commands:
+
+```python
+import logging
+logging.basicConfig(level=logging.DEBUG)
+
+# Commands will be logged before execution:
+client = PebbleCliClient()
+services = client.get_services()
+```
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history and changes.
+
+## Related Projects
+
+- [ops](https://ops.readthedocs.io) - The operator framework
+- [pebble](https://documentation.ubuntu.com/pebble) - The Pebble service manager
+- [juju](https://juju.is) - Juju
+- [charmcraft](https://canonical-charmcraft.readthedocs-hosted.com) - Juju charm development tools
+- [rockcraft](https://documentation.ubuntu.com/rockcraft) - Rock development tools