sherlock-api 0.1.0__tar.gz

sherlock_api-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+# Byte-compiled / cache
+__pycache__/
+*.py[cod]
+
+# Environments
+.venv/
+venv/
+.env
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/

sherlock_api-0.1.0/CHANGELOG.md

@@ -0,0 +1,72 @@
+# Changelog
+
+All notable changes to this project are documented here. This project adheres
+to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-09-19
+
+First packaged release. The code previously lived as loose top-level modules
+that could only be imported from the repository root; it is now the installable
+`sherlock-api` distribution exposing the `sherlock_api` package.
+
+### Added
+
+- `pip install sherlock-api`, with `requests` and `Pillow` declared as
+  dependencies and `py.typed` shipped so type checkers see the inline hints.
+- A single public import surface: `from sherlock_api import SherlockAPIClient, ...`.
+- Exception hierarchy in `sherlock_api.exceptions` — `SherlockError`,
+  `SherlockConfigurationError`, `SherlockAPIError` and the status-specific
+  `SherlockBadRequestError` / `SherlockNotFoundError` / `SherlockTimeoutError` /
+  `SherlockServerError`. `SherlockAPIError` subclasses `RuntimeError` and
+  `SherlockConfigurationError` subclasses `ValueError`, so existing
+  `except RuntimeError` / `except ValueError` handlers keep working.
+- Connection reuse via a `requests.Session`, a `request_timeout` (default 30 s)
+  applied to every call, and retries for connection errors and 502/503/504 on
+  GET/DELETE. `SherlockAPIClient` is now a context manager and has `close()`.
+- `log_case_error/warning/info` and `log_image_error/warning/info`, matching the
+  batch-level helpers that already existed.
+- `image_format` parameter on the `upload_image*` methods (previously always PNG).
+- `SHERLOCK_URL` environment variable, alongside the existing `SHERLOCK_PORT`,
+  `SHERLOCK_PROCESS_ID`, `SHERLOCK_CASE_ID` and `SHERLOCK_BATCH_ID`.
+- Docstrings throughout and return type annotations on every public method.
+
+### Fixed
+
+- **`image_utils` imported a name that does not exist** (`post_file_from_memory`
+  from `file_utils`), which made the whole library unimportable.
+- **Environment variables were read at import time**, because `os.getenv(...)`
+  sat in the constructor's default arguments. Any `SHERLOCK_*` variable set
+  after the module was first imported was silently ignored. They are now read
+  per instantiation.
+- **No request had a client-side timeout**, so a call could hang forever.
+  `get_modal` widens its own timeout to outlast its server-side long poll.
+- `get_file` compared `Content-Type` for exact equality and so rejected a
+  valid `application/octet-stream; charset=...`.
+- The library called `print()` on the `post_notification` 404 path; it now logs
+  to the `sherlock_api.client` logger.
+- Unbounded response bodies were interpolated into exception messages; they are
+  truncated to 500 characters.
+- `sherlock_batch_id` was accepted by the constructor but never used; it is now
+  the fallback for `get_batch`, `get_images_for_batch` and `upload_image*`.
+- `.txt` detection in `guess_extension_by_magic` no longer classifies any binary
+  containing a newline in its first 512 bytes as text.
+
+### Changed (breaking)
+
+- Import paths. `from sherlock_api_client import SherlockAPIClient` becomes
+  `from sherlock_api import SherlockAPIClient`; the `*_utils` modules are now
+  `sherlock_api.cases`, `.batches`, `.images`, `.logs`, `.measurements`,
+  `.process`, `.files` and `.validation`.
+- `post_modal`, `get_modal` and `delete_modal` take `process_id` as an optional
+  trailing argument that falls back to the client's process id, like every other
+  process method. `post_modal(process_id, modal)` becomes `post_modal(modal)`.
+- The `upload_image*` methods take `decision_class` before `batch_id`, so that
+  the now-optional `batch_id` comes last.
+- `upload_image_with_measurements` returns `(image, [measurement, ...])` instead
+  of `None`.
+- `delete_measurement` and `delete_modal` are annotated `-> None` (unchanged
+  behaviour, they never returned anything).
+- Request models are dataclasses. `CreateImageRequest.image_data` is now
+  `.image_hash`; the wire field is still `image_data`.
+- `CreateMeasurementRequest.value` accepts `int` and `float` and stringifies
+  them, instead of requiring the caller to do it.

sherlock_api-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Kirill Meisser
+
+   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.

sherlock_api-0.1.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.5
+Name: sherlock-api
+Version: 0.1.0
+Summary: Python client for the Sherlock REST API
+Project-URL: Homepage, https://github.com/sherlockrobotics/sherlock-python-api
+Project-URL: Repository, https://github.com/sherlockrobotics/sherlock-python-api
+Project-URL: Issues, https://github.com/sherlockrobotics/sherlock-python-api/issues
+Project-URL: Changelog, https://github.com/sherlockrobotics/sherlock-python-api/blob/main/CHANGELOG.md
+Author: Kirill Meisser
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: api,client,inspection,robotics,sherlock
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: pillow<13,>=10
+Requires-Dist: requests<3,>=2.31
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: responses>=0.25; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# sherlock-api
+
+Python client for the [Sherlock](https://github.com/kirillmeisser/sherlock-python-api) REST API.
+Build your own Sherlock applications — create cases and batches, upload
+inspection images with measurements, write log entries, and drive modal dialogs
+and notifications in a running Sherlock process.
+
+## Install
+
+```bash
+pip install sherlock-api
+```
+
+Requires Python 3.10+.
+
+## Quickstart
+
+```python
+from PIL import Image
+from sherlock_api import (
+    SherlockAPIClient,
+    CreateCaseRequest,
+    CreateBatchRequest,
+    RobotPlatform,
+    DecisionClass,
+)
+
+with SherlockAPIClient(sherlock_port=8080) as client:
+    case = client.post_case(
+        CreateCaseRequest(
+            "Bushing inspection",
+            RobotPlatform.UNIVERSAL_ROBOTS,
+            "0A0E012F7772596B03D92AAA544763BB",
+        )
+    )
+    batch = client.post_batch(CreateBatchRequest(case["id"], "Batch 1"))
+
+    image, measurements = client.upload_image_with_measurements(
+        Image.open("part.png"),
+        "part.png",
+        DecisionClass.Ok,
+        [("diameter_mm", 12.04), ("roundness", 0.98)],
+        batch["id"],
+    )
+
+    client.log_batch_info(batch["id"], f"Uploaded {image['image_name']}")
+```
+
+## Configuration
+
+Every constructor argument falls back to an environment variable. A script
+launched *by* Sherlock gets these for free, so `SherlockAPIClient()` with no
+arguments is usually all you need:
+
+| Argument | Environment variable | Default |
+| --- | --- | --- |
+| `sherlock_url` | `SHERLOCK_URL` | `http://localhost` |
+| `sherlock_port` | `SHERLOCK_PORT` | — (required) |
+| `sherlock_process_id` | `SHERLOCK_PROCESS_ID` | `None` |
+| `sherlock_case_id` | `SHERLOCK_CASE_ID` | `None` |
+| `sherlock_batch_id` | `SHERLOCK_BATCH_ID` | `None` |
+
+The three id defaults are used whenever you omit the corresponding argument —
+`client.get_case()` reads `sherlock_case_id`, `client.get_batch()` reads
+`sherlock_batch_id`, and the process methods read `sherlock_process_id`. Omitting
+an argument that has no default raises `SherlockConfigurationError`.
+
+Keyword-only options: `request_timeout` (seconds, default `30.0`), `max_retries`
+(default `3`, applied to connection errors and 502/503/504 on GET and DELETE),
+and `session` to supply your own `requests.Session`.
+
+## Modal dialogs
+
+`post_modal` returns a modal id; `get_modal` long-polls for the operator's
+answer and returns `DialogResult.NoResponse` if the poll expires. Its `timeout`
+is in **milliseconds** and is enforced by the server — the client timeout is
+widened automatically to outlast it.
+
+```python
+from sherlock_api import (
+    CreateProcessModalDialogRequest,
+    DialogType,
+    DialogResult,
+    Language,
+)
+
+modal_id = client.post_modal(
+    CreateProcessModalDialogRequest(DialogType.YesNo, Language.English, "Part looks OK?")
+)
+
+result = client.get_modal(modal_id, timeout=30_000)
+if result is DialogResult.NoResponse:
+    client.delete_modal(modal_id)
+```
+
+## Notifications
+
+```python
+from sherlock_api import CreateNotificationRequest, NotificationAttachment
+
+client.post_notification(
+    CreateNotificationRequest(
+        "Batch finished",
+        "42 parts inspected, 3 rejected.",
+        [NotificationAttachment("report.pdf", "application/pdf", pdf_bytes)],
+    )
+)
+```
+
+A notification sent to a process that no longer exists is logged as a warning
+on the `sherlock_api.client` logger rather than raised — it is fire-and-forget.
+
+## API surface
+
+| Area | Methods |
+| --- | --- |
+| Files | `get_file`, `post_file`, `post_file_from_memory` |
+| Cases | `get_cases`, `get_case`, `post_case` |
+| Batches | `get_batch`, `get_batches_for_case`, `post_batch` |
+| Images | `get_image`, `get_images_for_batch`, `post_image`, `upload_image`, `upload_image_with_measurement`, `upload_image_with_measurements` |
+| Logs | `get_log`, `post_log`, `log_{case,batch,image}_{error,warning,info}` |
+| Measurements | `get_measurement`, `post_measurement`, `delete_measurement` |
+| Processes | `get_process_state`, `is_process_running`, `get_env_state`, `get_env_vars`, `post_modal`, `get_modal`, `delete_modal`, `post_notification` |
+
+Methods returning JSON return the parsed `dict` or `list` from the server as-is.
+
+## Errors
+
+```text
+SherlockError
+├── SherlockConfigurationError   (also a ValueError)  missing port or id
+└── SherlockAPIError             (also a RuntimeError) unexpected HTTP status
+    ├── SherlockBadRequestError  400
+    ├── SherlockNotFoundError    404
+    ├── SherlockTimeoutError     408
+    └── SherlockServerError      5xx
+```
+
+`SherlockAPIError` carries `.status_code`, `.reason`, `.body` (truncated to 500
+characters), `.method` and `.url`.
+
+```python
+from sherlock_api import SherlockNotFoundError
+
+try:
+    client.get_case("0" * 32)
+except SherlockNotFoundError as err:
+    print(err.status_code, err.url)
+```
+
+Network-level failures (`requests.ConnectionError`, `requests.Timeout`)
+propagate from `requests` unchanged.
+
+## Logging
+
+The library logs to the `sherlock_api` logger and attaches a `NullHandler`, so
+it stays silent until your application configures logging:
+
+```python
+import logging
+
+logging.basicConfig(level=logging.INFO)
+```
+
+## Development
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+
+pytest            # offline, no Sherlock server needed
+ruff check .
+mypy src/
+```
+
+`examples/smoke_check.py` exercises the process endpoints against a live
+Sherlock instance.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

sherlock_api-0.1.0/README.md

@@ -0,0 +1,181 @@
+# sherlock-api
+
+Python client for the [Sherlock](https://github.com/kirillmeisser/sherlock-python-api) REST API.
+Build your own Sherlock applications — create cases and batches, upload
+inspection images with measurements, write log entries, and drive modal dialogs
+and notifications in a running Sherlock process.
+
+## Install
+
+```bash
+pip install sherlock-api
+```
+
+Requires Python 3.10+.
+
+## Quickstart
+
+```python
+from PIL import Image
+from sherlock_api import (
+    SherlockAPIClient,
+    CreateCaseRequest,
+    CreateBatchRequest,
+    RobotPlatform,
+    DecisionClass,
+)
+
+with SherlockAPIClient(sherlock_port=8080) as client:
+    case = client.post_case(
+        CreateCaseRequest(
+            "Bushing inspection",
+            RobotPlatform.UNIVERSAL_ROBOTS,
+            "0A0E012F7772596B03D92AAA544763BB",
+        )
+    )
+    batch = client.post_batch(CreateBatchRequest(case["id"], "Batch 1"))
+
+    image, measurements = client.upload_image_with_measurements(
+        Image.open("part.png"),
+        "part.png",
+        DecisionClass.Ok,
+        [("diameter_mm", 12.04), ("roundness", 0.98)],
+        batch["id"],
+    )
+
+    client.log_batch_info(batch["id"], f"Uploaded {image['image_name']}")
+```
+
+## Configuration
+
+Every constructor argument falls back to an environment variable. A script
+launched *by* Sherlock gets these for free, so `SherlockAPIClient()` with no
+arguments is usually all you need:
+
+| Argument | Environment variable | Default |
+| --- | --- | --- |
+| `sherlock_url` | `SHERLOCK_URL` | `http://localhost` |
+| `sherlock_port` | `SHERLOCK_PORT` | — (required) |
+| `sherlock_process_id` | `SHERLOCK_PROCESS_ID` | `None` |
+| `sherlock_case_id` | `SHERLOCK_CASE_ID` | `None` |
+| `sherlock_batch_id` | `SHERLOCK_BATCH_ID` | `None` |
+
+The three id defaults are used whenever you omit the corresponding argument —
+`client.get_case()` reads `sherlock_case_id`, `client.get_batch()` reads
+`sherlock_batch_id`, and the process methods read `sherlock_process_id`. Omitting
+an argument that has no default raises `SherlockConfigurationError`.
+
+Keyword-only options: `request_timeout` (seconds, default `30.0`), `max_retries`
+(default `3`, applied to connection errors and 502/503/504 on GET and DELETE),
+and `session` to supply your own `requests.Session`.
+
+## Modal dialogs
+
+`post_modal` returns a modal id; `get_modal` long-polls for the operator's
+answer and returns `DialogResult.NoResponse` if the poll expires. Its `timeout`
+is in **milliseconds** and is enforced by the server — the client timeout is
+widened automatically to outlast it.
+
+```python
+from sherlock_api import (
+    CreateProcessModalDialogRequest,
+    DialogType,
+    DialogResult,
+    Language,
+)
+
+modal_id = client.post_modal(
+    CreateProcessModalDialogRequest(DialogType.YesNo, Language.English, "Part looks OK?")
+)
+
+result = client.get_modal(modal_id, timeout=30_000)
+if result is DialogResult.NoResponse:
+    client.delete_modal(modal_id)
+```
+
+## Notifications
+
+```python
+from sherlock_api import CreateNotificationRequest, NotificationAttachment
+
+client.post_notification(
+    CreateNotificationRequest(
+        "Batch finished",
+        "42 parts inspected, 3 rejected.",
+        [NotificationAttachment("report.pdf", "application/pdf", pdf_bytes)],
+    )
+)
+```
+
+A notification sent to a process that no longer exists is logged as a warning
+on the `sherlock_api.client` logger rather than raised — it is fire-and-forget.
+
+## API surface
+
+| Area | Methods |
+| --- | --- |
+| Files | `get_file`, `post_file`, `post_file_from_memory` |
+| Cases | `get_cases`, `get_case`, `post_case` |
+| Batches | `get_batch`, `get_batches_for_case`, `post_batch` |
+| Images | `get_image`, `get_images_for_batch`, `post_image`, `upload_image`, `upload_image_with_measurement`, `upload_image_with_measurements` |
+| Logs | `get_log`, `post_log`, `log_{case,batch,image}_{error,warning,info}` |
+| Measurements | `get_measurement`, `post_measurement`, `delete_measurement` |
+| Processes | `get_process_state`, `is_process_running`, `get_env_state`, `get_env_vars`, `post_modal`, `get_modal`, `delete_modal`, `post_notification` |
+
+Methods returning JSON return the parsed `dict` or `list` from the server as-is.
+
+## Errors
+
+```text
+SherlockError
+├── SherlockConfigurationError   (also a ValueError)  missing port or id
+└── SherlockAPIError             (also a RuntimeError) unexpected HTTP status
+    ├── SherlockBadRequestError  400
+    ├── SherlockNotFoundError    404
+    ├── SherlockTimeoutError     408
+    └── SherlockServerError      5xx
+```
+
+`SherlockAPIError` carries `.status_code`, `.reason`, `.body` (truncated to 500
+characters), `.method` and `.url`.
+
+```python
+from sherlock_api import SherlockNotFoundError
+
+try:
+    client.get_case("0" * 32)
+except SherlockNotFoundError as err:
+    print(err.status_code, err.url)
+```
+
+Network-level failures (`requests.ConnectionError`, `requests.Timeout`)
+propagate from `requests` unchanged.
+
+## Logging
+
+The library logs to the `sherlock_api` logger and attaches a `NullHandler`, so
+it stays silent until your application configures logging:
+
+```python
+import logging
+
+logging.basicConfig(level=logging.INFO)
+```
+
+## Development
+
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+
+pytest            # offline, no Sherlock server needed
+ruff check .
+mypy src/
+```
+
+`examples/smoke_check.py` exercises the process endpoints against a live
+Sherlock instance.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).