confamnode 0.2.3__tar.gz → 0.2.5__tar.gz

confamnode-0.2.5/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

{confamnode-0.2.3 → confamnode-0.2.5}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: confamnode
-Version: 0.2.3
+Version: 0.2.5
 Summary: The Nigerian AI inference gateway
 Project-URL: Repository, https://github.com/confamnodeai/confamnode
 Project-URL: Bug Tracker, https://github.com/confamnodeai/confamnode/issues
 Author-email: JoTeq the First <hello@confamnode.com>
 License: Apache-2.0
+License-File: LICENSE
 Keywords: ai,confamnode,inference,joteq,llm,nigeria
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -253,6 +254,32 @@ ansa = client.gist(
 
 ---
 
+## Caching
+
+Caching is controlled **per request** and is **off by default** — every call returns a fresh response, even when the request is identical. This keeps data-generation loops and any workflow that resends the same prompt from getting the same cached answer back each time.
+
+Pass `cache=True` to read from and write to the cache — useful for idempotent lookups or to save cost on repeated queries:
+
+```python
+# Default — caching off, fresh response every call
+ansa = client.gist(
+    model="confam-speed",
+    messages="How you dey?"
+)
+
+# Enable caching — use a stored response when the request matches,
+# and store this response for next time
+ansa = client.gist(
+    model="confam-speed",
+    messages="How you dey?",
+    cache=True
+)
+```
+
+A cache hit is typically returned near-instantly and at little or no token cost — a quick way to confirm caching is active.
+
+---
+
 ## Reasoning Models
 
 Enable extended thinking for complex problems:
@@ -340,7 +367,7 @@ For enterprise clients running ConfamNode on private infrastructure:
 ```python
 client = ConfamNode(
     api_key="confam-xxx",
-    base_url="http://your-private-server:8000/v1"
+    base_url="http://your-private-server:4000/v1"
 )
 ```
 

{confamnode-0.2.3 → confamnode-0.2.5}/README.md

@@ -230,6 +230,32 @@ ansa = client.gist(
 
 ---
 
+## Caching
+
+Caching is controlled **per request** and is **off by default** — every call returns a fresh response, even when the request is identical. This keeps data-generation loops and any workflow that resends the same prompt from getting the same cached answer back each time.
+
+Pass `cache=True` to read from and write to the cache — useful for idempotent lookups or to save cost on repeated queries:
+
+```python
+# Default — caching off, fresh response every call
+ansa = client.gist(
+    model="confam-speed",
+    messages="How you dey?"
+)
+
+# Enable caching — use a stored response when the request matches,
+# and store this response for next time
+ansa = client.gist(
+    model="confam-speed",
+    messages="How you dey?",
+    cache=True
+)
+```
+
+A cache hit is typically returned near-instantly and at little or no token cost — a quick way to confirm caching is active.
+
+---
+
 ## Reasoning Models
 
 Enable extended thinking for complex problems:
@@ -317,7 +343,7 @@ For enterprise clients running ConfamNode on private infrastructure:
 ```python
 client = ConfamNode(
     api_key="confam-xxx",
-    base_url="http://your-private-server:8000/v1"
+    base_url="http://your-private-server:4000/v1"
 )
 ```
 

{confamnode-0.2.3 → confamnode-0.2.5}/confamnode/__init__.py

@@ -8,7 +8,7 @@ from confamnode.exceptions import (
 from confamnode.ansa import Ansa, Usage, Cost
 from confamnode import models
 
-__version__ = "0.2.3"
+__version__ = "0.2.5"
 
 __all__ = [
     "ConfamNode",

{confamnode-0.2.3 → confamnode-0.2.5}/confamnode/client.py

@@ -35,6 +35,7 @@ class ConfamNode:
         model: str,
         messages: Union[str, List[Dict[str, str]]],
         system: str | None = "default",
+        cache: bool = False,
         **kwargs
     ) -> "Ansa | ConfamStream":
         if model not in VALID_MODELS:
@@ -60,6 +61,25 @@ class ConfamNode:
             else:
                 body["system"] = system # None or custom string
 
+        # Caching is controlled per request. By default the SDK opts OUT, so
+        # identical requests (same model + messages + system) each return a
+        # FRESH response -- important for data-generation loops that resend the
+        # same prompt expecting varied output. Pass cache=True to read from and
+        # write to the cache (idempotent lookups, cost savings on repeats).
+        #
+        # These flags only tell the gateway whether to use a cache for THIS
+        # request; whether one exists at all is a gateway-side capability.
+        if cache:
+            body["cache"] = {
+                "no-cache": False, # Cache the response
+                "no-store": False # Store the response
+            }
+        else:
+            body["cache"] = {
+                "no-cache": True, # Skip cache check, get fresh response
+                "no-store": True # Don't cache this response
+            }
+
         if kwargs.get("stream", False):
             http_client = httpx.Client(
                 timeout=httpx.Timeout(DEFAULT_TIMEOUT, connect=DEFAULT_CONNECT_TIMEOUT)

confamnode-0.2.5/confamnode/utils.py

@@ -0,0 +1,48 @@
+"""
+Small internal helpers shared across the confamnode client.
+"""
+
+
+import re
+
+
+def extract_error(response) -> str:
+    """
+    Best-effort error detail from a non-2xx response, WITHOUT raising.
+ 
+    The server's normal error shape is {"detail": "..."}, but gateway-level
+    errors (e.g. a 429 throttle, a 502/504 from a proxy, a 524 origin timeout)
+    often return an empty or non-JSON body. Calling response.json() directly on
+    those bodies raises JSONDecodeError and swallows the status code -- the one
+    thing the caller actually needs. So we parse defensively and always fall
+    back to something readable.
+ 
+    HTML error pages (Cloudflare, nginx, ...) are summarised to their <title>
+    rather than dumped in full, so error messages and logs stay readable.
+    """
+    # 1. Normal JSON error shape.
+    try:
+        payload = response.json()
+        if isinstance(payload, dict):
+            detail = payload.get("detail") or payload.get("error") or payload.get("message")
+            if detail:
+                return str(detail)
+    except Exception:
+        pass
+
+    text = (getattr(response, "text", "") or "").strip()
+    if not text:
+        return  "no response body"
+    
+    # 2. HTML error page: the full page is noise. Pull the <title>, which
+    #    carries the human-readable status (e.g. "524: A timeout occurred").
+    if "<html" in text[:200].lower() or "<!doctype html" in text[:200].lower():
+        m = re.search(r"<title[^>]*>(.*?)</title>", text, re.IGNORECASE | re.DOTALL)
+        if m:
+            title = re.sub(r"\s+", " ", m.group(1)).strip()
+            if title:
+                return title
+        return "HTML error page (no title)"
+    
+    # 3. Plain-text body: return it, truncated so we never dump a wall.
+    return text if len(text) <= 300 else text[:297] + "..."

{confamnode-0.2.3 → confamnode-0.2.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "confamnode"
-version = "0.2.3"
+version = "0.2.5"
 description = "The Nigerian AI inference gateway"
 readme = "README.md"
 requires-python = ">=3.10"

confamnode-0.2.5/tests/test_cache_flag.py

@@ -0,0 +1,74 @@
+"""
+Tests for the per-request cache flag on ConfamNode.gist().
+
+Caching is opt-OUT by default: identical requests must each return a fresh
+response (critical for data-generation loops). cache=True flips the request
+to read-from + write-to the cache. These tests pin down the exact payload
+sent in each case so a future refactor can't silently flip the default.
+
+No network: httpx.post is monkeypatched to capture the request body.
+"""
+import httpx
+import pytest
+
+from confamnode.client import ConfamNode
+from confamnode.registry import VALID_MODELS
+
+API_KEY = "confam-test"
+MODEL = next(iter(VALID_MODELS))
+
+CACHE_OFF = {"no-cache": True, "no-store": True}    # skip read + skip store
+CACHE_ON = {"no-cache": False, "no-store": False}   # use + store
+
+
+@pytest.fixture
+def captured_body(monkeypatch):
+    """Patch httpx.post to record the JSON body and return a valid 200."""
+    box = {}
+
+    def fake_post(url, headers=None, json=None, timeout=None):
+        box["body"] = json
+
+        class _Resp:
+            status_code = 200
+            text = ""
+
+            def json(self):
+                return {
+                    "choices": [{"message": {"content": "hi"}, "finish_reason": "stop"}],
+                    "usage": {},
+                    "confam": {"cost": {"naira": 0.0}},
+                }
+
+        return _Resp()
+
+    monkeypatch.setattr(httpx, "post", fake_post)
+    return box
+
+
+def _gist(**kwargs):
+    ConfamNode(api_key=API_KEY).gist(model=MODEL, messages="x", **kwargs)
+
+
+def test_cache_off_by_default(captured_body):
+    _gist()
+    assert captured_body["body"]["cache"] == CACHE_OFF
+
+
+def test_cache_true_uses_and_stores(captured_body):
+    _gist(cache=True)
+    assert captured_body["body"]["cache"] == CACHE_ON
+
+
+def test_cache_false_is_explicit_off(captured_body):
+    _gist(cache=False)
+    assert captured_body["body"]["cache"] == CACHE_OFF
+
+
+def test_cache_field_always_present(captured_body):
+    # The request should always state its caching intent in both directions,
+    # never leave it implied by omission.
+    _gist()
+    assert "cache" in captured_body["body"]
+    _gist(cache=True)
+    assert "cache" in captured_body["body"]

{confamnode-0.2.3 → confamnode-0.2.5}/tests/test_client_errors.py

@@ -58,14 +58,20 @@ def test_json_detail_error_surfaces_detail(monkeypatch):
     assert "invalid model" in str(exc.value)
 
 
-def test_html_gateway_error_surfaces_text(monkeypatch):
-    _patch_post(monkeypatch, FakeResponse(502, json_raises=True,
-                                          text="<html>502 Bad Gateway</html>"))
+def test_html_gateway_error_surfaces_title(monkeypatch):
+    html = (
+        "<!DOCTYPE html><html><head>"
+        "<title>confamnode.com | 524: A timeout occurred</title>"
+        "</head><body>...</body></html>"
+    )
+    _patch_post(monkeypatch, FakeResponse(524, json_raises=True, text=html))
     client = ConfamNode(api_key=API_KEY)
     with pytest.raises(Exception) as exc:
         client.gist(model=MODEL, messages="hi")
-    assert "502" in str(exc.value)
-    assert "Bad Gateway" in str(exc.value)
+    msg = str(exc.value)
+    assert "524" in msg
+    assert "A timeout occurred" in msg
+    assert "<html" not in msg   # the page itself must NOT be dumped into the error
 
 
 def test_success_path_still_returns_ansa(monkeypatch):

{confamnode-0.2.3 → confamnode-0.2.5}/tests/test_utils.py

@@ -29,6 +29,27 @@ def test_non_json_text_body_is_returned_stripped():
     assert extract_error(_Resp(json_raises=True, text="  upstream timeout  ")) == "upstream timeout"
 
 
+def test_html_error_page_summarised_to_title():
+    # A Cloudflare 524 page: don't dump the whole page, surface the <title>.
+    html = (
+        "<!DOCTYPE html><html><head>"
+        "<title>confamnode.com | 524: A timeout occurred</title>"
+        "</head><body>...lots of markup...</body></html>"
+    )
+    assert extract_error(_Resp(json_raises=True, text=html)) == "confamnode.com | 524: A timeout occurred"
+
+
+def test_html_without_title_falls_back():
+    html = "<html><body>502 Bad Gateway</body></html>"
+    assert extract_error(_Resp(json_raises=True, text=html)) == "HTML error page (no title)"
+
+
+def test_long_plain_text_is_truncated():
+    body = "x" * 500
+    out = extract_error(_Resp(json_raises=True, text=body))
+    assert len(out) == 300 and out.endswith("...")
+
+
 def test_detail_key_is_preferred():
     assert extract_error(_Resp(payload={"detail": "invalid model"})) == "invalid model"
 

{confamnode-0.2.3 → confamnode-0.2.5}/uv.lock

@@ -40,7 +40,7 @@ wheels = [
 
 [[package]]
 name = "confamnode"
-version = "0.2.3"
+version = "0.2.4"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },

confamnode-0.2.3/confamnode/utils.py

@@ -1,26 +0,0 @@
-"""
-Small internal helpers shared across the confamnode client.
-"""
-
-
-def extract_error(response) -> str:
-    """
-    Best-effort error detail from a non-2xx response, WITHOUT raising.
- 
-    The server's normal error shape is {"detail": "..."}, but gateway-level
-    errors (e.g. a 429 throttle, a 502/504 from a proxy) often return an
-    empty or non-JSON body. Calling response.json() directly on those bodies
-    raises JSONDecodeError and swallows the status code -- the one thing the
-    caller actually needs. So we parse defensively and always fall back to
-    the raw text, then to a status-only message.
-    """
-    try:
-        payload = response.json()
-        if isinstance(payload, dict):
-            detail = payload.get("detail") or payload.get("error") or payload.get("message")
-            if detail:
-                return str(detail)
-    except Exception:
-        pass
-    text = (getattr(response, "text", "") or "").strip()
-    return text or "no response body"