diffusr 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

diffusr/__init__.py

@@ -6,6 +6,7 @@
 """
 
 from ._client import DEFAULT_BASE_URL, TERMINAL_STATUSES, Diffusr
+from ._config import config_path, read_config
 from ._errors import DiffusrError
 from ._verify import SIGNATURE_TOLERANCE_SEC, verify_callback
 
@@ -13,8 +14,10 @@ __all__ = [
     "Diffusr",
     "DiffusrError",
     "verify_callback",
+    "config_path",
+    "read_config",
     "DEFAULT_BASE_URL",
     "TERMINAL_STATUSES",
     "SIGNATURE_TOLERANCE_SEC",
 ]
-__version__ = "0.1.0"
+__version__ = "0.2.0"

diffusr/_client.py

@@ -11,11 +11,12 @@ import urllib.request
 import uuid
 from typing import Any, Callable, Dict, Mapping, Optional, Union
 
+from ._config import config_path, read_config  # noqa: F401
 from ._errors import DiffusrError
 from ._verify import verify_callback as _verify_callback
 
 DEFAULT_BASE_URL = "https://app.diffusr.ai/api/v2"
-SDK_VERSION = "0.1.0"
+SDK_VERSION = "0.2.0"
 TERMINAL_STATUSES = ("SUCCEEDED", "FAILED", "CANCELED")
 # Never sleep longer than this on one automatic retry; raise instead.
 MAX_AUTO_RETRY_WAIT_SEC = 30
@@ -30,7 +31,10 @@ _CONTENT_TYPES = {
 class Diffusr:
     """Client for the diffusr REST API (v2). Bodies and answers are the API's own snake_case JSON.
 
-    api_key   dfsr_live_... or dfsr_test_... (free). Default: the DIFFUSR_KEY environment variable.
+    api_key   dfsr_live_... or dfsr_test_... (free). Default: the DIFFUSR_KEY environment variable,
+              then the key `npx diffusr login` saved (see config_path()).
+    base_url  Default: DIFFUSR_BASE_URL, then the saved file's base_url (only when the key came
+              from the file), then https://app.diffusr.ai/api/v2.
     """
 
     def __init__(
@@ -43,10 +47,16 @@ class Diffusr:
         timeout: float = 60.0,
     ) -> None:
         key = api_key or os.environ.get("DIFFUSR_KEY")
+        file_base: Optional[str] = None
         if not key:
-            raise DiffusrError(0, "MISSING_API_KEY", "Pass an API key or set DIFFUSR_KEY.")
+            saved = read_config()
+            if saved:
+                key = saved["key"]
+                file_base = saved.get("base_url") or None
+        if not key:
+            raise DiffusrError(0, "MISSING_API_KEY", "Pass an API key, set DIFFUSR_KEY, or run `npx diffusr login`.")
         self._key = key
-        self._base = (base_url or DEFAULT_BASE_URL).rstrip("/")
+        self._base = (base_url or os.environ.get("DIFFUSR_BASE_URL") or file_base or DEFAULT_BASE_URL).rstrip("/")
         self._max_retries = max_retries
         self._retry_base = retry_base
         self._timeout = timeout
@@ -191,6 +201,21 @@ class Diffusr:
     def rotate_callback_secret(self) -> Dict[str, Any]:
         return self._request("POST", "/callbacks/secret/rotate", body={})
 
+    def call(
+        self,
+        method: str,
+        path: str,
+        query: Optional[Mapping[str, Any]] = None,
+        body: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, str]] = None,
+    ) -> Dict[str, Any]:
+        """Call any API path the typed methods do not cover, e.g. call("GET", "/me").
+        Same retries and errors as every other call. Add your own Idempotency-Key
+        header for a make call."""
+        q = {k: (str(v).lower() if isinstance(v, bool) else v) for k, v in (query or {}).items() if v is not None}
+        suffix = f"?{urllib.parse.urlencode(q)}" if q else ""
+        return self._request(method, path + suffix, body=body, headers=headers)
+
     @staticmethod
     def verify_callback(
         raw_body: Union[str, bytes],

diffusr/_config.py

@@ -0,0 +1,29 @@
+"""The key `npx diffusr login` saves, so Python code can use it too."""
+
+from __future__ import annotations
+
+import json
+import os
+import sys
+from typing import Any, Dict, Optional
+
+
+def config_path() -> str:
+    """$XDG_CONFIG_HOME/diffusr/config.json, else ~/.config/diffusr/config.json; on Windows %APPDATA%\\diffusr\\config.json."""
+    if sys.platform == "win32":
+        base = os.environ.get("APPDATA") or os.path.join(os.path.expanduser("~"), "AppData", "Roaming")
+    else:
+        base = os.environ.get("XDG_CONFIG_HOME") or os.path.join(os.path.expanduser("~"), ".config")
+    return os.path.join(base, "diffusr", "config.json")
+
+
+def read_config() -> Optional[Dict[str, Any]]:
+    """The saved config (it has a "key"), or None when there is none. Never raises."""
+    try:
+        with open(config_path(), "r", encoding="utf-8") as f:
+            data = json.load(f)
+    except (OSError, ValueError):
+        return None
+    if isinstance(data, dict) and isinstance(data.get("key"), str) and data["key"]:
+        return data
+    return None

{diffusr-0.1.0.dist-info → diffusr-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: diffusr
-Version: 0.1.0
+Version: 0.2.0
 Summary: The diffusr API client: make videos, images and music from code. Free price checks, idempotent starts, wait_for, signed callbacks.
 Project-URL: Homepage, https://diffusr.ai
 Project-URL: Documentation, https://diffusr.ai/docs
@@ -33,7 +33,7 @@ Mint keys on the Developers page in the app.
 ```python
 from diffusr import Diffusr
 
-diffusr = Diffusr()  # reads DIFFUSR_KEY
+diffusr = Diffusr()  # reads DIFFUSR_KEY, else the key `npx diffusr login` saved
 
 # 1. Ask the price. Free: nothing is made, nothing is spent.
 quote = diffusr.make_video(
@@ -81,6 +81,28 @@ def hook():
 constant-time compare, two signatures after a secret rotation, a 5-minute
 timestamp window, `whsec_` prefix handled.
 
+## Command line
+
+Install the `diffusr` command with npm (it needs Node 18+) and log in once:
+
+```sh
+npx diffusr login        # shows a code, opens your browser, saves a key
+npx diffusr whoami
+npx diffusr make_image "a mug on a sunlit table"
+```
+
+For scripts and agents add `--json` (only the JSON answer on stdout) and
+`--yes` (allow spending; without it nothing is made). `npx diffusr help` lists
+every command.
+
+**Where the key is saved.** `~/.config/diffusr/config.json` (or
+`$XDG_CONFIG_HOME/diffusr/config.json`; on Windows `%APPDATA%\diffusr\config.json`).
+Only you can read it. `Diffusr()` uses it when no key is given.
+
+**Which key wins.** The `api_key` argument, then the `DIFFUSR_KEY` variable,
+then the saved file. The API address: the `base_url` argument, then
+`DIFFUSR_BASE_URL`, then the saved file's `base_url`.
+
 ## Methods
 
 | Method | REST |

diffusr-0.2.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+diffusr/__init__.py,sha256=Z_R1dexi8lV4krgWfXaecz5PRhcxkDtHo5fQgAaaQgg,600
+diffusr/_client.py,sha256=iHriOw2jy9gahN63oHR-bk5wkVc7qMQcfms1UgYU5R8,13289
+diffusr/_config.py,sha256=idMnlOT4UI1ic85e_ISsfpCGdUGq39XVxCrkB3q-NGU,1053
+diffusr/_errors.py,sha256=YWrBDO9lzEqHgckTc66uLcpETfvbWmeyhmB2rFVJkzc,1184
+diffusr/_verify.py,sha256=d5pNG-qf3CtXWuI5Ejm614kB96o0shMPE9xa34s_ZgM,1954
+diffusr/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diffusr-0.2.0.dist-info/METADATA,sha256=ImEyCP3N1Lu_t0he-VrS6WCuiBqhNq1f9tOqp_K0KEw,6019
+diffusr-0.2.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+diffusr-0.2.0.dist-info/licenses/LICENSE,sha256=1l1mtdgkeKxmibt4kNGlmLRfZhUQWNx-rJB0lQD_dWY,1064
+diffusr-0.2.0.dist-info/RECORD,,

diffusr-0.1.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-diffusr/__init__.py,sha256=GJu0H3cqXBbB8VunnZqrzq0rqAGhOGSlEpP0i1Fasvo,516
-diffusr/_client.py,sha256=MMyVDdmff1nIQSuiFKf_9c0sJDITUSY-fkNQjodgKyI,12005
-diffusr/_errors.py,sha256=YWrBDO9lzEqHgckTc66uLcpETfvbWmeyhmB2rFVJkzc,1184
-diffusr/_verify.py,sha256=d5pNG-qf3CtXWuI5Ejm614kB96o0shMPE9xa34s_ZgM,1954
-diffusr/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-diffusr-0.1.0.dist-info/METADATA,sha256=XzZOenx6fc7hiOEjMPj-vlsA6LzXjNtfus3xZDAC76A,5151
-diffusr-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
-diffusr-0.1.0.dist-info/licenses/LICENSE,sha256=1l1mtdgkeKxmibt4kNGlmLRfZhUQWNx-rJB0lQD_dWY,1064
-diffusr-0.1.0.dist-info/RECORD,,