interject 0.1.0__tar.gz

interject-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+
+# Rust
+target/
+**/*.rs.bk
+
+# Local state
+*.sqlite3
+*.sqlite3-*
+.env

interject-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 [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.
+

interject-0.1.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.5
+Name: interject
+Version: 0.1.0
+Summary: A durable ask() primitive: stop, ask a human, resume.
+Project-URL: Homepage, https://github.com/TheJohnMatti/interject
+Project-URL: Repository, https://github.com/TheJohnMatti/interject
+Project-URL: Issues, https://github.com/TheJohnMatti/interject/issues
+Project-URL: Changelog, https://github.com/TheJohnMatti/interject/releases
+Author: John Matti
+License: Apache-2.0
+License-File: LICENSE
+Keywords: approval,durable,human-in-the-loop,pipeline,workflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+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 :: Software Development :: Libraries
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-xdist; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# interject
+
+**A durable `ask()` primitive.** A program can stop, ask a human, and resume —
+days later, on another machine, in one tap.
+
+```python
+from interject import ask
+
+vehicle = ask(
+    "Is this a car?",
+    options=["car", "motorcycle", "boat", "trailer"],
+    id="vehicle_type",
+    context={"title": listing.title, "price": listing.price},
+    suggest={"value": "motorcycle", "confidence": 0.94},
+)
+```
+
+That call registers a question, lets everything not downstream of it keep
+running, reaches you wherever you are, and returns the answer **to this line of
+this program** — even if the process exited and was restarted two days later on
+different hardware. It may also never reach you at all, if the triage layer is
+confident enough. That is the point.
+
+## Why
+
+Modern pipelines are mostly autonomous with a handful of points where human
+judgment is irreducible. Today each of those is a bespoke JSON file nobody is
+watching, a blocking `input()` at a terminal nobody is sitting at, or a hard
+stop.
+
+## How it behaves
+
+**It does not block.** By default `ask` long-polls briefly and then raises
+`Suspended`, so the caller exits cleanly. The next run recomputes the same
+content-addressed key and gets the stored answer immediately:
+
+```python
+import interject
+
+try:
+    kind = interject.ask("Is this a car?", options=["car", "moto"],
+                         id="vehicle_type", context=listing, wait=0)
+except interject.Suspended:
+    return  # somebody will answer; the next run picks it up
+```
+
+Pass `on_timeout="block"` for an interactive script, or `on_timeout="default"`
+with a `default=` for best-effort enrichment.
+
+**Scanning a backlog does not create a backlog of questions.** `ask` registers as
+it checks, so use `peek` to look without creating:
+
+```python
+key = interject.key_for("vehicle_type", listing)
+if interject.peek_answer(key) is None:
+    ...  # not answered yet
+```
+
+**Silence is the other half.** A job can declare what it owes you, and going
+quiet becomes an event:
+
+```python
+interject.heartbeat("nightly.etl", expect_every="26h")
+```
+
+## Installation
+
+```bash
+pip install interject
+```
+
+No dependencies, Python 3.9+. It talks to an `interjectd` daemon over HTTP —
+see the [repository](https://github.com/TheJohnMatti/interject) for running one,
+for the one-tap phone inbox, and for the triage layer that makes it ask less
+over time.
+
+## Configuration
+
+| variable | default | meaning |
+|---|---|---|
+| `INTERJECT_URL` | `http://127.0.0.1:8787` | daemon base URL |
+| `INTERJECT_TOKEN` | *(none)* | project or device token |
+| `INTERJECT_PROJECT` | `default` | project name, for daemons without tokens |
+| `INTERJECT_IDENTITY` | *(none)* | who you answer as, for routing |
+
+Licensed under Apache-2.0.

interject-0.1.0/README.md

@@ -0,0 +1,86 @@
+# interject
+
+**A durable `ask()` primitive.** A program can stop, ask a human, and resume —
+days later, on another machine, in one tap.
+
+```python
+from interject import ask
+
+vehicle = ask(
+    "Is this a car?",
+    options=["car", "motorcycle", "boat", "trailer"],
+    id="vehicle_type",
+    context={"title": listing.title, "price": listing.price},
+    suggest={"value": "motorcycle", "confidence": 0.94},
+)
+```
+
+That call registers a question, lets everything not downstream of it keep
+running, reaches you wherever you are, and returns the answer **to this line of
+this program** — even if the process exited and was restarted two days later on
+different hardware. It may also never reach you at all, if the triage layer is
+confident enough. That is the point.
+
+## Why
+
+Modern pipelines are mostly autonomous with a handful of points where human
+judgment is irreducible. Today each of those is a bespoke JSON file nobody is
+watching, a blocking `input()` at a terminal nobody is sitting at, or a hard
+stop.
+
+## How it behaves
+
+**It does not block.** By default `ask` long-polls briefly and then raises
+`Suspended`, so the caller exits cleanly. The next run recomputes the same
+content-addressed key and gets the stored answer immediately:
+
+```python
+import interject
+
+try:
+    kind = interject.ask("Is this a car?", options=["car", "moto"],
+                         id="vehicle_type", context=listing, wait=0)
+except interject.Suspended:
+    return  # somebody will answer; the next run picks it up
+```
+
+Pass `on_timeout="block"` for an interactive script, or `on_timeout="default"`
+with a `default=` for best-effort enrichment.
+
+**Scanning a backlog does not create a backlog of questions.** `ask` registers as
+it checks, so use `peek` to look without creating:
+
+```python
+key = interject.key_for("vehicle_type", listing)
+if interject.peek_answer(key) is None:
+    ...  # not answered yet
+```
+
+**Silence is the other half.** A job can declare what it owes you, and going
+quiet becomes an event:
+
+```python
+interject.heartbeat("nightly.etl", expect_every="26h")
+```
+
+## Installation
+
+```bash
+pip install interject
+```
+
+No dependencies, Python 3.9+. It talks to an `interjectd` daemon over HTTP —
+see the [repository](https://github.com/TheJohnMatti/interject) for running one,
+for the one-tap phone inbox, and for the triage layer that makes it ask less
+over time.
+
+## Configuration
+
+| variable | default | meaning |
+|---|---|---|
+| `INTERJECT_URL` | `http://127.0.0.1:8787` | daemon base URL |
+| `INTERJECT_TOKEN` | *(none)* | project or device token |
+| `INTERJECT_PROJECT` | `default` | project name, for daemons without tokens |
+| `INTERJECT_IDENTITY` | *(none)* | who you answer as, for routing |
+
+Licensed under Apache-2.0.

interject-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "interject"
+version = "0.1.0"
+description = "A durable ask() primitive: stop, ask a human, resume."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Apache-2.0" }
+license-files = ["LICENSE"]
+authors = [{ name = "John Matti" }]
+keywords = ["human-in-the-loop", "approval", "workflow", "durable", "pipeline"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: System :: Distributed Computing",
+  "Typing :: Typed",
+]
+
+dependencies = []
+[project.urls]
+Homepage = "https://github.com/TheJohnMatti/interject"
+Repository = "https://github.com/TheJohnMatti/interject"
+Issues = "https://github.com/TheJohnMatti/interject/issues"
+Changelog = "https://github.com/TheJohnMatti/interject/releases"
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "pytest-cov", "pytest-xdist", "ruff", "mypy"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/interject"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.mypy]
+strict = true
+python_version = "3.10"   # mypy no longer targets 3.9; runtime support stays >=3.9
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["interject"]
+
+[tool.coverage.report]
+# Ratchet this up as coverage improves; never down to make a red build green.
+fail_under = 90
+show_missing = true

interject-0.1.0/src/interject/__init__.py

@@ -0,0 +1,116 @@
+"""interject — a durable ``ask()`` primitive.
+
+Stop a program, ask a human, resume days later on another machine:
+
+    >>> from interject import ask
+    >>> vehicle = ask("Is this a car?", options=["car", "moto"], id="vehicle_type")
+
+and the outbound half of the same idea, where silence is the event:
+
+    >>> from interject import heartbeat
+    >>> heartbeat("nightly.etl", expect_every="26h")
+"""
+from __future__ import annotations
+
+from typing import Any
+
+from ._client import DEFAULT_PRIORITY, DEFAULT_WAIT, KINDS, ON_TIMEOUT, Client
+from ._duration import Duration
+from ._keys import context_digest, question_key
+from .errors import (
+    Expired,
+    InterjectError,
+    ProtocolError,
+    Suspended,
+    Unauthorized,
+    Unreachable,
+)
+
+__all__ = [
+    "DEFAULT_PRIORITY",
+    "DEFAULT_WAIT",
+    "KINDS",
+    "ON_TIMEOUT",
+    "Client",
+    "Duration",
+    "Expired",
+    "InterjectError",
+    "ProtocolError",
+    "Suspended",
+    "Unauthorized",
+    "Unreachable",
+    "__version__",
+    "answer",
+    "ask",
+    "context_digest",
+    "heartbeat",
+    "inbox",
+    "key_for",
+    "peek",
+    "peek_answer",
+    "question_key",
+    "release",
+]
+
+__version__ = "0.1.0"
+
+_default_client: Client | None = None
+
+
+def _client() -> Client:
+    """The process-wide client, configured from the environment on first use."""
+    global _default_client
+    if _default_client is None:
+        _default_client = Client()
+    return _default_client
+
+
+def ask(prompt: str, **kwargs: Any) -> Any:
+    """Ask a human using the process-wide client. See :meth:`Client.ask`."""
+    kwargs.setdefault("_stacklevel", 3)
+    return _client().ask(prompt, **kwargs)
+
+
+def answer(key: str, value: Any, **kwargs: Any) -> Any:
+    """Answer a question using the process-wide client. See :meth:`Client.answer`."""
+    return _client().answer(key, value, **kwargs)
+
+
+def inbox(**kwargs: Any) -> Any:
+    """Open questions, grouped by batch. See :meth:`Client.inbox`."""
+    return _client().inbox(**kwargs)
+
+
+def claim(key: str, ttl_seconds: int | None = None) -> Any:
+    """Hold a question while you work on it. See :meth:`Client.claim`."""
+    return _client().claim(key, ttl_seconds)
+
+
+def release(key: str) -> Any:
+    """Give up a claim. See :meth:`Client.release`."""
+    return _client().release(key)
+
+
+def assign(key: str, to: str | None) -> Any:
+    """Route a question to one person. See :meth:`Client.assign`."""
+    return _client().assign(key, to)
+
+
+def key_for(id: str, context: Any = None) -> str:
+    """The key the process-wide client would use. See :meth:`Client.key_for`."""
+    return _client().key_for(id, context)
+
+
+def peek(key: str) -> Any:
+    """Look at a question without creating one. See :meth:`Client.peek`."""
+    return _client().peek(key)
+
+
+def peek_answer(key: str, default: Any = None) -> Any:
+    """The stored answer for ``key``, or ``default``. See :meth:`Client.peek_answer`."""
+    return _client().peek_answer(key, default)
+
+
+def heartbeat(name: str, **kwargs: Any) -> None:
+    """Report a live signal using the process-wide client. See :meth:`Client.heartbeat`."""
+    return _client().heartbeat(name, **kwargs)