folio-sdk 0.1.0__py3-none-any.whl

folio/__init__.py

@@ -0,0 +1,79 @@
+"""Folio SDK — publish HTML reports as shareable, hosted URLs."""
+
+from __future__ import annotations
+
+import os
+from typing import Optional
+
+__version__ = "0.1.0"
+__all__ = ["configure", "publish"]
+
+_BASE_URL = "https://folio.ac"
+_api_key: Optional[str] = None
+
+
+def configure(api_key: str, *, base_url: str = _BASE_URL) -> None:
+    """Set the API key for all subsequent publish() calls.
+
+    Args:
+        api_key: Your Folio API key (starts with fol_). Copy from folio.ac/dashboard.
+        base_url: Override the Folio base URL (useful for self-hosted instances).
+    """
+    global _api_key, _BASE_URL
+    _api_key = api_key
+    _BASE_URL = base_url.rstrip("/")
+
+
+def publish(
+    html: str,
+    *,
+    title: str = "",
+    expires_in_days: int = 7,
+    password: str = "",
+    custom_slug: str = "",
+    api_key: Optional[str] = None,
+) -> str:
+    """Publish an HTML report to Folio and return the shareable URL.
+
+    Args:
+        html: Complete HTML document to publish. Max 2 MB.
+        title: Human-readable title shown in the report header and dashboard.
+        expires_in_days: How long the report stays live. One of 7, 14, 30, 90.
+        password: Optional password to gate the report.
+        custom_slug: Custom URL path (e.g. "q2-revenue" → folio.ac/you/r/q2-revenue).
+                     Requires a claimed username and a valid API key.
+        api_key: Override the key set by configure(). Also reads FOLIO_API_KEY env var.
+
+    Returns:
+        The shareable URL, e.g. "https://folio.ac/r/abc123".
+
+    Raises:
+        ImportError: If the 'requests' package is not installed.
+        requests.HTTPError: If the API returns a non-2xx response.
+    """
+    try:
+        import requests
+    except ImportError as exc:
+        raise ImportError(
+            "folio requires the 'requests' package. Install it with: pip install requests"
+        ) from exc
+
+    key = api_key or _api_key or os.environ.get("FOLIO_API_KEY")
+    headers: dict[str, str] = {"Content-Type": "application/json"}
+    if key:
+        headers["x-api-key"] = key
+
+    payload: dict[str, object] = {"html": html}
+    if title:
+        payload["title"] = title
+    if expires_in_days != 7:
+        payload["expiresInDays"] = expires_in_days
+    if password:
+        payload["password"] = password
+    if custom_slug:
+        payload["customSlug"] = custom_slug
+
+    base = _BASE_URL
+    r = requests.post(f"{base}/api/publish", json=payload, headers=headers, timeout=30)
+    r.raise_for_status()
+    return r.json()["url"]

folio_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: folio-sdk
+Version: 0.1.0
+Summary: Publish HTML reports as shareable, hosted URLs — Folio Python SDK
+Project-URL: Homepage, https://folio.ac
+Project-URL: Documentation, https://folio.ac/docs
+License: MIT
+Keywords: agents,ai,folio,html,publish,reports
+Requires-Python: >=3.8
+Requires-Dist: requests>=2.20
+Description-Content-Type: text/markdown
+
+# folio-sdk
+
+Publish HTML reports as shareable, hosted URLs — [Folio](https://folio.ac) Python SDK.
+
+```bash
+pip install folio-sdk
+```
+
+## Usage
+
+```python
+import folio
+
+folio.configure("fol_your_key_here")  # or set FOLIO_API_KEY env var
+
+url = folio.publish(html, title="Q2 Analysis")
+print(url)  # → https://folio.ac/r/abc123
+```
+
+Get your API key at [folio.ac/dashboard](https://folio.ac/dashboard).
+
+## Options
+
+```python
+url = folio.publish(
+    html,
+    title="Q2 Revenue",
+    expires_in_days=30,   # 7 | 14 | 30 | 90 (default: 7)
+    password="secret",    # optional gate
+    custom_slug="q2-rev", # → folio.ac/you/r/q2-rev
+)
+```
+
+## Agent / LLM usage
+
+```python
+import anthropic, folio
+
+folio.configure("fol_your_key_here")
+client = anthropic.Anthropic()
+
+msg = client.messages.create(
+    model="claude-opus-4-7",
+    max_tokens=8096,
+    messages=[{"role": "user", "content": "Analyse this data and return a full HTML report with charts."}],
+)
+
+url = folio.publish(msg.content[0].text, title="Analysis")
+print(f"Report: {url}")
+```
+
+## Links
+
+- [Docs](https://folio.ac/docs)
+- [Dashboard](https://folio.ac/dashboard)

folio_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,4 @@
+folio/__init__.py,sha256=dmG3TFmR6_8eqe-2Jxkr0GzDuVObG07V-a3n-x6u21M,2519
+folio_sdk-0.1.0.dist-info/METADATA,sha256=Q3uuIYCOdVfOEbWOLSNUJAy31ZJqMmE5Q9PtNl_XTwQ,1510
+folio_sdk-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+folio_sdk-0.1.0.dist-info/RECORD,,

folio_sdk-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any