borescope 0.1.0b1__tar.gz

borescope-0.1.0b1/.gitignore

@@ -0,0 +1,35 @@
+__pycache__
+/sandbox
+.idea
+*~
+.venv
+venv
+.vscode
+.coverage
+coverage.xml
+htmlcov
+/.tox
+.*.swp
+.ruff_cache
+.pytest_cache
+
+# Tokens and settings for `act` to run GHA locally
+.env
+.envrc
+.secrets
+
+# Build artifacts
+/cascade.egg-info
+/dist
+/build
+
+# Agents
+.claude/*local*
+
+# Local docs-preview tooling writes this when viewing the page
+/docs/localStorage.json
+
+# libFuzzer-generated corpus entries (SHA1-named).
+# The hand-written seeds use descriptive names and stay tracked; ignore the
+# auto-discovered ones that accumulate during local fuzz runs.
+tests/fuzz/corpus/[0-9a-f]*

borescope-0.1.0b1/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.
+   

borescope-0.1.0b1/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: borescope
+Version: 0.1.0b1
+Summary: A natural shell for debugging Juju Kubernetes workload containers via Pebble
+Project-URL: Homepage, https://github.com/tonyandrewmeyer/borescope
+Project-URL: Repository, https://github.com/tonyandrewmeyer/borescope
+Project-URL: Bug Tracker, https://github.com/tonyandrewmeyer/borescope/issues
+Author-email: Tony Meyer <borescope@aotearoa.dev>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: charm,debugging,juju,kubernetes,pebble,shell
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+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 :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: ops<4,>=2.0.0
+Requires-Dist: pebble-shimmer>=1.0.0b2
+Requires-Dist: prompt-toolkit>=3.0
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# borescope
+
+A natural shell for debugging Juju Kubernetes **workload** containers.
+
+Kubernetes charm workload containers usually run a [rock](https://documentation.ubuntu.com/rockcraft/)
+with no shell — so when something breaks, `juju ssh --container=workload …` drops
+you nowhere useful. borescope gives you a prompt that *feels* like `bash` but talks to
+the container's [Pebble](https://documentation.ubuntu.com/pebble/) instead of a real shell:
+
+```console
+$ borescope myapp/0
+pebble:/# ls /var/log/myapp
+pebble:/# tail -f /var/log/myapp/error.log
+pebble:/# services
+pebble:/# logs --follow myapp
+pebble:/# plan
+pebble:/# exit
+```
+
+No setup ceremony: borescope picks up your current Juju controller/model and uses your
+existing `juju` authority — if you can `juju ssh` to the unit, borescope works; if you
+can't, it fails the same way.
+
+## Install
+
+> v1 is under active development. For now, from a checkout:
+
+```console
+uv tool install .        # or: pipx install .
+```
+
+## Usage
+
+```console
+borescope <unit>                       # default (first) workload container
+borescope <unit> --container=<name>    # a specific workload container
+borescope --model <model> <unit>
+borescope <unit> --command "services"  # one-shot, no REPL (for scripts)
+borescope <unit> --snapshot            # dump container state as JSON
+```
+
+## Documentation
+
+Full documentation — a tutorial, how-to guides, and CLI/command reference — is
+at **<https://tonyandrewmeyer.github.io/borescope/>**.
+
+The docs are plain Markdown under [`docs/src/`](docs/src/), built into static
+HTML with a small script (no docs framework). To build them locally:
+
+```console
+uv run python docs/src/_build.py     # or: tox -e docs
+```
+
+See [`docs/README.md`](docs/README.md) for the authoring rules.
+
+## How it works
+
+borescope is three thin, independently-testable layers:
+
+- **Transport** — talks to a Pebble. The primary backend (`CliTransport`) reaches the
+  workload's Pebble *through the charm container* — `juju ssh <unit>` (the charm
+  container always has a shell) pointed at the workload's socket, which Juju mounts
+  there at `/charm/containers/<name>/pebble.socket`. This works even against rocks
+  with **no shell** (the shell lives in the charm container, not the rock) and stays
+  entirely within your Juju authority — no `kubectl` or cluster-admin. It drives
+  `pebble` via [shimmer](https://github.com/tonyandrewmeyer/shimmer) (a drop-in
+  `ops.pebble.Client` over the Pebble CLI). When the Pebble socket is directly
+  reachable (running inside the charm, or a local Pebble), `SocketTransport` uses the
+  real `ops.pebble.Client` HTTP API instead.
+- **Discovery** — turns a unit reference into the right Pebble: confirms the unit,
+  reads the charm's `metadata.yaml` for workload container names, and sanity-checks
+  the container is alive. Everything uses your Juju model access — no `kubectl` /
+  cluster-admin.
+- **Shell** — a small REPL: `cd`/`pwd`, path-aware tab completion, history, and a
+  minimal command set. Pebble's own vocabulary (`services`, `logs`, `plan`, …) is
+  first-class, not hidden behind a `pebble` prefix. For anything else, `exec <cmd>`
+  runs a binary that's already in the container.
+
+## Scope
+
+borescope is for **Kubernetes** charms (which run Pebble). Machine charms already have
+a real shell and are out of scope. It deliberately ships a *minimal* command set and
+grows on request — if a tool exists in the container, reach it with `exec`.

borescope-0.1.0b1/README.md

@@ -0,0 +1,83 @@
+# borescope
+
+A natural shell for debugging Juju Kubernetes **workload** containers.
+
+Kubernetes charm workload containers usually run a [rock](https://documentation.ubuntu.com/rockcraft/)
+with no shell — so when something breaks, `juju ssh --container=workload …` drops
+you nowhere useful. borescope gives you a prompt that *feels* like `bash` but talks to
+the container's [Pebble](https://documentation.ubuntu.com/pebble/) instead of a real shell:
+
+```console
+$ borescope myapp/0
+pebble:/# ls /var/log/myapp
+pebble:/# tail -f /var/log/myapp/error.log
+pebble:/# services
+pebble:/# logs --follow myapp
+pebble:/# plan
+pebble:/# exit
+```
+
+No setup ceremony: borescope picks up your current Juju controller/model and uses your
+existing `juju` authority — if you can `juju ssh` to the unit, borescope works; if you
+can't, it fails the same way.
+
+## Install
+
+> v1 is under active development. For now, from a checkout:
+
+```console
+uv tool install .        # or: pipx install .
+```
+
+## Usage
+
+```console
+borescope <unit>                       # default (first) workload container
+borescope <unit> --container=<name>    # a specific workload container
+borescope --model <model> <unit>
+borescope <unit> --command "services"  # one-shot, no REPL (for scripts)
+borescope <unit> --snapshot            # dump container state as JSON
+```
+
+## Documentation
+
+Full documentation — a tutorial, how-to guides, and CLI/command reference — is
+at **<https://tonyandrewmeyer.github.io/borescope/>**.
+
+The docs are plain Markdown under [`docs/src/`](docs/src/), built into static
+HTML with a small script (no docs framework). To build them locally:
+
+```console
+uv run python docs/src/_build.py     # or: tox -e docs
+```
+
+See [`docs/README.md`](docs/README.md) for the authoring rules.
+
+## How it works
+
+borescope is three thin, independently-testable layers:
+
+- **Transport** — talks to a Pebble. The primary backend (`CliTransport`) reaches the
+  workload's Pebble *through the charm container* — `juju ssh <unit>` (the charm
+  container always has a shell) pointed at the workload's socket, which Juju mounts
+  there at `/charm/containers/<name>/pebble.socket`. This works even against rocks
+  with **no shell** (the shell lives in the charm container, not the rock) and stays
+  entirely within your Juju authority — no `kubectl` or cluster-admin. It drives
+  `pebble` via [shimmer](https://github.com/tonyandrewmeyer/shimmer) (a drop-in
+  `ops.pebble.Client` over the Pebble CLI). When the Pebble socket is directly
+  reachable (running inside the charm, or a local Pebble), `SocketTransport` uses the
+  real `ops.pebble.Client` HTTP API instead.
+- **Discovery** — turns a unit reference into the right Pebble: confirms the unit,
+  reads the charm's `metadata.yaml` for workload container names, and sanity-checks
+  the container is alive. Everything uses your Juju model access — no `kubectl` /
+  cluster-admin.
+- **Shell** — a small REPL: `cd`/`pwd`, path-aware tab completion, history, and a
+  minimal command set. Pebble's own vocabulary (`services`, `logs`, `plan`, …) is
+  first-class, not hidden behind a `pebble` prefix. For anything else, `exec <cmd>`
+  runs a binary that's already in the container.
+
+## Scope
+
+borescope is for **Kubernetes** charms (which run Pebble). Machine charms already have
+a real shell and are out of scope. It deliberately ships a *minimal* command set and
+grows on request — if a tool exists in the container, reach it with `exec`.

borescope-0.1.0b1/pyproject.toml

@@ -0,0 +1,219 @@
+[project]
+name = "borescope"
+version = "0.1.0b1"
+description = "A natural shell for debugging Juju Kubernetes workload containers via Pebble"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+authors = [
+    {name = "Tony Meyer", email = "borescope@aotearoa.dev"},
+]
+keywords = ["juju", "pebble", "kubernetes", "charm", "shell", "debugging"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: System :: Systems Administration",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "ops>=2.0.0,<4",
+    "pebble-shimmer>=1.0.0b2",
+    "prompt_toolkit>=3.0",
+    "PyYAML>=6.0",
+]
+
+[dependency-groups]
+dev = [
+    "atheris>=2.3.0",
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "pytest-mock>=3.10.0",
+    "ruff==0.15.14",
+    "ty==0.0.38",
+    "tox>=4.22.0",
+    "pre-commit>=3.0.0",
+]
+docs = [
+    "jinja2>=3.1",
+    "markdown-it-py>=3.0",
+    "mdit-py-plugins>=0.4",
+    "PyYAML>=6.0",
+]
+
+[project.scripts]
+borescope = "borescope.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/tonyandrewmeyer/borescope"
+Repository = "https://github.com/tonyandrewmeyer/borescope"
+"Bug Tracker" = "https://github.com/tonyandrewmeyer/borescope/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/borescope"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+]
+
+# Ruff configuration
+[tool.ruff]
+line-length = 99
+target-version = "py311"
+src = ["src", "tests"]
+
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.ruff.lint]
+# CPY (flake8-copyright) currently requires preview mode.
+preview = true
+explicit-preview-rules = true
+select = [
+    # Pyflakes
+    "F",
+    # Pycodestyle
+    "E",
+    "W",
+    # isort
+    "I001",
+    # pep8-naming
+    "N",
+    # flake8-builtins
+    "A",
+    # flake8-copyright
+    "CPY001",
+    # pyupgrade
+    "UP",
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # Ruff-specific
+    "RUF",
+    # Perflint
+    "PERF",
+    # pydocstyle
+    "D",
+    # flake8-future-annotations
+    "FA",
+    # flake8-type-checking
+    "TC",
+]
+ignore = [
+    # Line too long: handled by the formatter.
+    "E501",
+    # Don't force imports into TYPE_CHECKING blocks.
+    "TC001",
+    "TC002",
+    "TC003",
+    # assert is fine.
+    "S101",
+    # Magic methods and __init__ don't need docstrings.
+    "D105",
+    "D107",
+    # subprocess call: check for execution of untrusted input. False-positive heavy.
+    "S603",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.flake8-builtins]
+builtins-ignorelist = ["id", "min", "map", "range", "type", "input", "format", "exit", "help"]
+
+[tool.ruff.lint.flake8-copyright]
+notice-rgx = "(?i)Copyright \\d{4} Tony Meyer"
+
+[tool.ruff.lint.per-file-ignores]
+# Command classes are self-documenting via their ``name``/``summary``/``usage``
+# attributes; a docstring would only restate ``summary``.
+"src/borescope/shell/commands/*.py" = [
+    "D101",
+    "D102",
+]
+# Transport is a structural ``Protocol`` mirroring ``ops.pebble.Client``; the
+# upstream API is the docstring.
+"src/borescope/transport/__init__.py" = [
+    "D102",
+]
+"tests/*" = [
+    # Docstrings aren't required in tests.
+    "D",
+    # Hard-coded "secrets" are fine in tests.
+    "S105",
+    "S106",
+]
+"tests/**/*" = [
+    "D",
+    "S105",
+    "S106",
+]
+# The docs build script intentionally keeps two things ruff would flag:
+"docs/src/_build.py" = [
+    # The entity-rewrite table maps literal "ambiguous" Unicode characters
+    # (en dash, curly quotes, ...) to HTML entities — they must stay as-is.
+    "RUF001",
+    # Jinja2 autoescape is deliberately off: the body is trusted, already-
+    # rendered HTML, and escaping it would double-encode the docs.
+    "S701",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["borescope"]
+
+# Pytest configuration
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+]
+testpaths = ["tests"]
+markers = [
+    "integration: marks tests that require a real pebble binary (deselect with '-m \"not integration\"')",
+    "requires_juju: marks tests that require a live Juju controller",
+]
+
+[tool.coverage.run]
+source = ["src"]
+branch = true
+omit = [
+    "tests/*",
+    "*/__pycache__/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if False:",
+    "if __name__ == .__main__.:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+    "if TYPE_CHECKING:",
+]
+show_missing = true
+precision = 2

borescope-0.1.0b1/src/borescope/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2026 Tony Meyer
+# SPDX-License-Identifier: Apache-2.0
+
+"""borescope - a natural shell for debugging Juju Kubernetes workload containers."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version('borescope')
+except PackageNotFoundError:  # pragma: no cover - running from an uninstalled tree
+    __version__ = '0.0.0+unknown'
+
+__all__ = ['__version__']

borescope-0.1.0b1/src/borescope/__main__.py

@@ -0,0 +1,13 @@
+# Copyright 2026 Tony Meyer
+# SPDX-License-Identifier: Apache-2.0
+
+"""``python -m borescope`` entry point."""
+
+from __future__ import annotations
+
+import sys
+
+from .cli import main
+
+if __name__ == '__main__':
+    sys.exit(main())