shidoshi 0.0.1__tar.gz

shidoshi-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          python-version: "3.13"
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

shidoshi-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest tests/unit tests/btp tests/test_import_rule.py -v

shidoshi-0.0.1/.gitignore

@@ -0,0 +1,20 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Jupyter
+.ipynb_checkpoints/
+
+# shidoshi runtime artifacts
+.shidoshi_cache.json
+*.png
+
+# generated docs
+docs/*.html

shidoshi-0.0.1/LICENSE

@@ -0,0 +1,191 @@
+
+                                 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
+
+   Copyright 2026 Chaitanya
+
+   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.

shidoshi-0.0.1/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.4
+Name: shidoshi
+Version: 0.0.1
+Summary: An opinionated way to augment Jupyter Lab for iterative work
+Project-URL: Homepage, https://github.com/tdchaitanya/shidoshi
+Project-URL: Repository, https://github.com/tdchaitanya/shidoshi
+Project-URL: Issues, https://github.com/tdchaitanya/shidoshi/issues
+Author-email: Chaitanya <tdchaitanya@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-assistant,jupyter,jupyterlab,llm,openai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Jupyter
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.13
+Requires-Dist: ipylab>=0.6
+Requires-Dist: ipynbname>=2025.8.0.0
+Requires-Dist: ipython>=8.39.0
+Requires-Dist: openai>=2.41.1
+Requires-Dist: trio>=0.25
+Requires-Dist: typing-extensions>=4.0
+Provides-Extra: notebook
+Requires-Dist: ipywidgets>=8.0; extra == 'notebook'
+Description-Content-Type: text/markdown
+
+# shidoshi
+
+[![PyPI](https://img.shields.io/pypi/v/shidoshi.svg)](https://pypi.org/project/shidoshi/)
+[![CI](https://github.com/tdchaitanya/shidoshi/actions/workflows/test.yml/badge.svg)](https://github.com/tdchaitanya/shidoshi/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+An opinionated way to augment Jupyter Lab for iterative work.
+
+shidoshi adds `%ask` / `%%ask` magics to Jupyter that let you talk to an LLM
+from inside a notebook — using the notebook itself, in order, as the
+conversation history. No separate chat pane, no copy-pasting context: your
+code cells, their outputs, and your notes are the context.
+
+## Install
+
+Requires Python ≥3.13 and JupyterLab. Set an API key before use:
+
+```bash
+export OPENAI_API_KEY=sk-...       # for the openai provider (default)
+export OPENAI_BASE_URL=...         # optional, e.g. to point at a proxy
+export OPENROUTER_API_KEY=...      # for the openrouter provider
+```
+
+### Installing across Jupyter environments
+
+`%load_ext shidoshi` runs `import shidoshi` **inside the running kernel
+process**. That means shidoshi has to be installed into whichever Python
+environment the kernel you're using actually runs in — it is not a
+standalone CLI, so `uvx` / `uv tool install` (which run a tool in an
+isolated subprocess, separate from any kernel) don't apply here.
+
+- **Per-project venv with its own JupyterLab** (e.g. a `uv`-managed project):
+  add shidoshi as a normal dependency of that project.
+
+  ```bash
+  uv add shidoshi
+  # or: pip install shidoshi
+  ```
+
+- **One shared JupyterLab, many kernels** (each notebook's kernel points at a
+  different project venv registered via `ipykernel install`): install
+  shidoshi into *each* kernel's venv. Installing it only where JupyterLab
+  itself lives will not make it importable from other kernels.
+
+  ```bash
+  # inside the venv backing a given kernel
+  uv add shidoshi
+  # or: pip install shidoshi
+  ```
+
+- **Auto-load without typing `%load_ext` every time**: add to
+  `~/.ipython/profile_default/ipython_config.py` (create it first with
+  `ipython profile create` if it doesn't exist):
+
+  ```python
+  c.InteractiveShellApp.extensions = ["shidoshi"]
+  ```
+
+  `~/.ipython` is a single directory shared by every Python environment
+  under your `$HOME` — it is **not** per-venv. So this line will make every
+  kernel try to load shidoshi at startup, regardless of which venv it's
+  running in. Two ways to keep that safe:
+
+  1. Only add it once shidoshi is installed in **every** environment you use
+     for Jupyter on that machine, or
+  2. Scope it to specific projects: create a named profile
+     (`ipython profile create shidoshi`), put the `extensions` line in that
+     profile's config instead of `profile_default`, and point only the
+     relevant kernel(s) at it (add `"--profile=shidoshi"` to that kernel's
+     `argv` in its `kernel.json`, or install with
+     `ipython kernel install --profile=shidoshi ...`).
+
+## Quickstart
+
+```
+%load_ext shidoshi
+```
+
+```
+%%ask
+What does the `history.build_history` function in this file do?
+```
+
+The response streams into the cell's output as Markdown.
+
+## Magics reference
+
+- **`%ask <prompt>`** — line magic for a one-line prompt.
+  - Prefix with `model|` or `provider:model|` to override the configured
+    default model for just this call, e.g. `%ask openrouter:openai/gpt-4o|summarize this`.
+  - Add `--debug` anywhere on the line to also show the full request/response
+    payload.
+- **`%%ask [model]`** — cell magic; the whole cell body is the prompt
+  (multi-line is fine, and it can reference images via Markdown
+  `![]()`/`<img>` syntax or bare local file paths — they're inlined as
+  base64). An optional model name on the magic line overrides the default
+  for this call. Also supports `--debug`.
+- **`%%skip`** — runs the cell normally, but the cell is left out of the
+  context sent to the model entirely. Use it for scratch or exploratory
+  cells you don't want the model to see.
+- **`%%pin`** — runs the cell normally; its content and output are *always*
+  included in context and are exempt from the auto-trim behavior below. Use
+  it to protect a fact, constant, or definition you don't want dropped over
+  a long session.
+
+## How context is built
+
+Every prior cell in the notebook — up to the one you're currently running,
+and accounting for kernel restarts — is turned into conversation history
+automatically:
+
+- **Markdown cells** become background text/image context (treated as notes
+  or reference material, not instructions).
+- **Regular code cells** appear as fenced code plus their text/image
+  outputs.
+- **Prior `%ask` / `%%ask` cells** become real user/assistant turns. Their
+  responses are reused from a per-cell cache rather than re-sent, so
+  replaying history doesn't resend answers the model already produced.
+- **`%%skip` cells** are dropped entirely.
+- **`%%pin` cells** are always kept.
+
+## Automatic context-length handling
+
+If a request is rejected for exceeding the model's context window, shidoshi
+automatically retries, dropping the oldest trimmable history units first
+(markdown cells, then plain code cells, then whole ask+response pairs —
+`%%pin` cells are never dropped), up to 20 times. A banner reports how many
+cells were dropped so you know context shrank.
+
+## Providers & tools
+
+- **`openai`** (default) — uses the OpenAI Responses API.
+- **`openrouter`** — uses OpenRouter's chat-completions API; select it with
+  the `provider:model` prefix, e.g. `openrouter:anthropic/claude-3.5-sonnet`.
+
+Every request currently has the built-in `web_search` tool attached, so the
+model can search the web when it needs current information. (A `web_fetch`
+tool also exists in the codebase but isn't wired into the magics yet — not
+available today.)
+
+## Debug mode
+
+Add `--debug` to `%ask`/`%%ask` to render a collapsible, syntax-highlighted
+panel showing exactly what was sent (system prompt, full message history,
+tools) and every raw event streamed back — useful when the model's behavior
+is surprising and you want to see the actual payload.
+
+## Configuration
+
+shidoshi reads TOML config, layered as defaults → `~/.shidoshi/config.toml`
+→ `./.shidoshi/config.toml` (project config overrides user config):
+
+```toml
+default_model = "gpt-5.5"   # model used when none is specified
+reasoning_effort = "low"    # OpenAI only
+ask_color = "#eafbea"       # highlight color for %ask/%%ask cells
+skip_color = "#ececec"      # highlight color for %%skip cells
+```
+
+## Development
+
+```bash
+uv sync
+uv run pytest tests/unit tests/btp -v
+```
+
+Integration tests under `tests/integration/` require a live `OPENAI_API_KEY`
+(or a proxy via `OPENAI_BASE_URL`) and are run with:
+
+```bash
+uv run pytest tests/integration/ -v -m integration
+```
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).

shidoshi-0.0.1/README.md

@@ -0,0 +1,176 @@
+# shidoshi
+
+[![PyPI](https://img.shields.io/pypi/v/shidoshi.svg)](https://pypi.org/project/shidoshi/)
+[![CI](https://github.com/tdchaitanya/shidoshi/actions/workflows/test.yml/badge.svg)](https://github.com/tdchaitanya/shidoshi/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+An opinionated way to augment Jupyter Lab for iterative work.
+
+shidoshi adds `%ask` / `%%ask` magics to Jupyter that let you talk to an LLM
+from inside a notebook — using the notebook itself, in order, as the
+conversation history. No separate chat pane, no copy-pasting context: your
+code cells, their outputs, and your notes are the context.
+
+## Install
+
+Requires Python ≥3.13 and JupyterLab. Set an API key before use:
+
+```bash
+export OPENAI_API_KEY=sk-...       # for the openai provider (default)
+export OPENAI_BASE_URL=...         # optional, e.g. to point at a proxy
+export OPENROUTER_API_KEY=...      # for the openrouter provider
+```
+
+### Installing across Jupyter environments
+
+`%load_ext shidoshi` runs `import shidoshi` **inside the running kernel
+process**. That means shidoshi has to be installed into whichever Python
+environment the kernel you're using actually runs in — it is not a
+standalone CLI, so `uvx` / `uv tool install` (which run a tool in an
+isolated subprocess, separate from any kernel) don't apply here.
+
+- **Per-project venv with its own JupyterLab** (e.g. a `uv`-managed project):
+  add shidoshi as a normal dependency of that project.
+
+  ```bash
+  uv add shidoshi
+  # or: pip install shidoshi
+  ```
+
+- **One shared JupyterLab, many kernels** (each notebook's kernel points at a
+  different project venv registered via `ipykernel install`): install
+  shidoshi into *each* kernel's venv. Installing it only where JupyterLab
+  itself lives will not make it importable from other kernels.
+
+  ```bash
+  # inside the venv backing a given kernel
+  uv add shidoshi
+  # or: pip install shidoshi
+  ```
+
+- **Auto-load without typing `%load_ext` every time**: add to
+  `~/.ipython/profile_default/ipython_config.py` (create it first with
+  `ipython profile create` if it doesn't exist):
+
+  ```python
+  c.InteractiveShellApp.extensions = ["shidoshi"]
+  ```
+
+  `~/.ipython` is a single directory shared by every Python environment
+  under your `$HOME` — it is **not** per-venv. So this line will make every
+  kernel try to load shidoshi at startup, regardless of which venv it's
+  running in. Two ways to keep that safe:
+
+  1. Only add it once shidoshi is installed in **every** environment you use
+     for Jupyter on that machine, or
+  2. Scope it to specific projects: create a named profile
+     (`ipython profile create shidoshi`), put the `extensions` line in that
+     profile's config instead of `profile_default`, and point only the
+     relevant kernel(s) at it (add `"--profile=shidoshi"` to that kernel's
+     `argv` in its `kernel.json`, or install with
+     `ipython kernel install --profile=shidoshi ...`).
+
+## Quickstart
+
+```
+%load_ext shidoshi
+```
+
+```
+%%ask
+What does the `history.build_history` function in this file do?
+```
+
+The response streams into the cell's output as Markdown.
+
+## Magics reference
+
+- **`%ask <prompt>`** — line magic for a one-line prompt.
+  - Prefix with `model|` or `provider:model|` to override the configured
+    default model for just this call, e.g. `%ask openrouter:openai/gpt-4o|summarize this`.
+  - Add `--debug` anywhere on the line to also show the full request/response
+    payload.
+- **`%%ask [model]`** — cell magic; the whole cell body is the prompt
+  (multi-line is fine, and it can reference images via Markdown
+  `![]()`/`<img>` syntax or bare local file paths — they're inlined as
+  base64). An optional model name on the magic line overrides the default
+  for this call. Also supports `--debug`.
+- **`%%skip`** — runs the cell normally, but the cell is left out of the
+  context sent to the model entirely. Use it for scratch or exploratory
+  cells you don't want the model to see.
+- **`%%pin`** — runs the cell normally; its content and output are *always*
+  included in context and are exempt from the auto-trim behavior below. Use
+  it to protect a fact, constant, or definition you don't want dropped over
+  a long session.
+
+## How context is built
+
+Every prior cell in the notebook — up to the one you're currently running,
+and accounting for kernel restarts — is turned into conversation history
+automatically:
+
+- **Markdown cells** become background text/image context (treated as notes
+  or reference material, not instructions).
+- **Regular code cells** appear as fenced code plus their text/image
+  outputs.
+- **Prior `%ask` / `%%ask` cells** become real user/assistant turns. Their
+  responses are reused from a per-cell cache rather than re-sent, so
+  replaying history doesn't resend answers the model already produced.
+- **`%%skip` cells** are dropped entirely.
+- **`%%pin` cells** are always kept.
+
+## Automatic context-length handling
+
+If a request is rejected for exceeding the model's context window, shidoshi
+automatically retries, dropping the oldest trimmable history units first
+(markdown cells, then plain code cells, then whole ask+response pairs —
+`%%pin` cells are never dropped), up to 20 times. A banner reports how many
+cells were dropped so you know context shrank.
+
+## Providers & tools
+
+- **`openai`** (default) — uses the OpenAI Responses API.
+- **`openrouter`** — uses OpenRouter's chat-completions API; select it with
+  the `provider:model` prefix, e.g. `openrouter:anthropic/claude-3.5-sonnet`.
+
+Every request currently has the built-in `web_search` tool attached, so the
+model can search the web when it needs current information. (A `web_fetch`
+tool also exists in the codebase but isn't wired into the magics yet — not
+available today.)
+
+## Debug mode
+
+Add `--debug` to `%ask`/`%%ask` to render a collapsible, syntax-highlighted
+panel showing exactly what was sent (system prompt, full message history,
+tools) and every raw event streamed back — useful when the model's behavior
+is surprising and you want to see the actual payload.
+
+## Configuration
+
+shidoshi reads TOML config, layered as defaults → `~/.shidoshi/config.toml`
+→ `./.shidoshi/config.toml` (project config overrides user config):
+
+```toml
+default_model = "gpt-5.5"   # model used when none is specified
+reasoning_effort = "low"    # OpenAI only
+ask_color = "#eafbea"       # highlight color for %ask/%%ask cells
+skip_color = "#ececec"      # highlight color for %%skip cells
+```
+
+## Development
+
+```bash
+uv sync
+uv run pytest tests/unit tests/btp -v
+```
+
+Integration tests under `tests/integration/` require a live `OPENAI_API_KEY`
+(or a proxy via `OPENAI_BASE_URL`) and are run with:
+
+```bash
+uv run pytest tests/integration/ -v -m integration
+```
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).