vbd-api 0.1.0__tar.gz

vbd_api-0.1.0/.gitignore

@@ -0,0 +1,105 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# IDE and editors
+.idea/
+.vscode/
+
+# Dependencies
+node_modules/
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# Testing
+/coverage
+
+# Next.js
+.next/
+/out/
+next-env.d.ts
+*.tsbuildinfo
+
+# Production builds
+/build
+dist/
+dist
+
+# Environment files (comprehensive coverage)
+
+*token.json*
+*credentials.json*
+
+# Logs and debug files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+dump.rdb
+
+# System files
+.DS_Store
+*.pem
+
+# Python
+__pycache__/
+*pyc*
+venv/
+.venv/
+
+# Development tools
+chainlit.md
+.chainlit
+.ipynb_checkpoints/
+.ac
+
+# Deployment
+.vercel
+
+# Data and databases
+agenthub/agents/youtube/db
+
+# Archive files and large assets
+**/*.zip
+**/*.tar.gz
+**/*.tar
+**/*.tgz
+*.pack
+*.deb
+*.dylib
+
+# Build caches
+.cache/
+
+memory/test_credentials.md
+
+# Mobile development
+android-sdk/frontend/node_modules/@next/swc-linux-arm64-gnu/next-swc.linux-arm64-gnu.node
+frontend/node_modules/@next/swc-linux-arm64-musl/next-swc.linux-arm64-musl.node
+credentials.json
+*.key
+.credentials
+frontend/node_modules/@next/swc-linux-arm64-gnu/next-swc.linux-arm64-gnu.node
+frontend/.next/cache/webpack/client-production/0.pack
+frontend/.next/cache/webpack/server-production/0.pack
+frontend/.next/cache/webpack/server-production/1.pack
+frontend/.next/cache/webpack/server-production/3.pack
+frontend/.next/cache/webpack/server-production/7.pack
+frontend/.next/cache/webpack/server-production/6.pack
+frontend/.next/cache/webpack/server-production/8.pack
+
+# Outreach claim-link exports (contain live claim tokens — never commit)
+outreach_claim_links_*.csv
+.env
+.env.*
+*.env
+
+# Safe env templates (no real secrets) - explicitly allowed
+!.env.example
+!frontend/.env.example
+!backend/.env.example

vbd_api-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.5
+Name: vbd-api
+Version: 0.1.0
+Summary: Official Python client for the Veteran Benefit Desk API: structured, source linked VA benefits data with permanent VBD IDs and provenance.
+Project-URL: Homepage, https://veteranbenefitdesk.com/developers
+Project-URL: Documentation, https://veteranbenefitdesk.com/developers
+Project-URL: Registry, https://veteranbenefitdesk.com/developers/registry
+Author-email: Veteran Benefit Desk <support@veteranbenefitdesk.com>
+License: MIT
+Keywords: api,benefits,disability,va,vbd,veterans
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: requests>=2.28
+Description-Content-Type: text/markdown
+
+# vbd-api
+
+Official Python client for the [Veteran Benefit Desk API](https://veteranbenefitdesk.com/developers): structured, source linked VA benefits data with permanent VBD IDs, provenance in every response, and honest review tiers.
+
+You are only charged credits for successful responses. Errors and not found lookups are always free.
+
+## Install
+
+```bash
+pip install vbd-api
+```
+
+## Quickstart
+
+```python
+from vbd_api import VBD
+
+client = VBD(api_key="vbd_sbx_...")  # free key at https://veteranbenefitdesk.com/developers/signup
+
+# Diagnostic codes
+ptsd = client.get_diagnostic_code("9411")
+print(ptsd["data"]["title"])                 # PTSD
+print(ptsd["vbd"]["id"])                     # VBD:DC:9411
+print(ptsd["provenance"]["sources"])         # 38 CFR Part 4 ...
+
+# Conditions
+client.search_conditions(q="knee", limit=10)
+client.get_condition("tinnitus")
+
+# VA forms
+client.search_forms(q="disability")
+client.get_form("21-526EZ")
+
+# State benefits (2 credits)
+client.get_state_benefits("TX", category="property_tax")
+
+# Your usage (free)
+client.usage()
+
+# Metering info from the last call
+print(client.last_receipt_id, client.credits_remaining)
+```
+
+## Errors
+
+All API errors raise `vbd_api.VBDError` with `.status` and `.detail`:
+
+```python
+from vbd_api import VBD, VBDError
+
+try:
+    client.get_diagnostic_code("99999")
+except VBDError as e:
+    print(e.status, e.detail)  # 404 Unknown diagnostic code... (not billed)
+```
+
+## Notes
+
+- Veteran Benefit Desk is independent and not affiliated with the U.S. Department of Veterans Affairs or any government agency.
+- Data is general educational information from public sources. It is not legal, medical, individualized claims, or representative advice.
+- License: commercial use with attribution ("Data via Veteran Benefit Desk"). Training rights are not granted by default.

vbd_api-0.1.0/README.md

@@ -0,0 +1,61 @@
+# vbd-api
+
+Official Python client for the [Veteran Benefit Desk API](https://veteranbenefitdesk.com/developers): structured, source linked VA benefits data with permanent VBD IDs, provenance in every response, and honest review tiers.
+
+You are only charged credits for successful responses. Errors and not found lookups are always free.
+
+## Install
+
+```bash
+pip install vbd-api
+```
+
+## Quickstart
+
+```python
+from vbd_api import VBD
+
+client = VBD(api_key="vbd_sbx_...")  # free key at https://veteranbenefitdesk.com/developers/signup
+
+# Diagnostic codes
+ptsd = client.get_diagnostic_code("9411")
+print(ptsd["data"]["title"])                 # PTSD
+print(ptsd["vbd"]["id"])                     # VBD:DC:9411
+print(ptsd["provenance"]["sources"])         # 38 CFR Part 4 ...
+
+# Conditions
+client.search_conditions(q="knee", limit=10)
+client.get_condition("tinnitus")
+
+# VA forms
+client.search_forms(q="disability")
+client.get_form("21-526EZ")
+
+# State benefits (2 credits)
+client.get_state_benefits("TX", category="property_tax")
+
+# Your usage (free)
+client.usage()
+
+# Metering info from the last call
+print(client.last_receipt_id, client.credits_remaining)
+```
+
+## Errors
+
+All API errors raise `vbd_api.VBDError` with `.status` and `.detail`:
+
+```python
+from vbd_api import VBD, VBDError
+
+try:
+    client.get_diagnostic_code("99999")
+except VBDError as e:
+    print(e.status, e.detail)  # 404 Unknown diagnostic code... (not billed)
+```
+
+## Notes
+
+- Veteran Benefit Desk is independent and not affiliated with the U.S. Department of Veterans Affairs or any government agency.
+- Data is general educational information from public sources. It is not legal, medical, individualized claims, or representative advice.
+- License: commercial use with attribution ("Data via Veteran Benefit Desk"). Training rights are not granted by default.

vbd_api-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vbd-api"
+version = "0.1.0"
+description = "Official Python client for the Veteran Benefit Desk API: structured, source linked VA benefits data with permanent VBD IDs and provenance."
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.8"
+authors = [{ name = "Veteran Benefit Desk", email = "support@veteranbenefitdesk.com" }]
+keywords = ["va", "veterans", "benefits", "disability", "api", "vbd"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+]
+dependencies = ["requests>=2.28"]
+
+[project.urls]
+Homepage = "https://veteranbenefitdesk.com/developers"
+Documentation = "https://veteranbenefitdesk.com/developers"
+Registry = "https://veteranbenefitdesk.com/developers/registry"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/vbd_api"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/vbd_api", "README.md"]

vbd_api-0.1.0/src/vbd_api/__init__.py

@@ -0,0 +1,4 @@
+from .client import VBD, VBDError
+
+__version__ = "0.1.0"
+__all__ = ["VBD", "VBDError", "__version__"]

vbd_api-0.1.0/src/vbd_api/client.py

@@ -0,0 +1,91 @@
+import requests
+
+DEFAULT_BASE_URL = "https://veteranbenefitdesk.com"
+_VERSION = "0.1.0"
+
+
+class VBDError(Exception):
+    """Raised for any non 2xx API response. Carries .status and .detail."""
+
+    def __init__(self, status, detail):
+        self.status = status
+        self.detail = detail
+        super().__init__(f"{status}: {detail}")
+
+
+class VBD:
+    """Client for the Veteran Benefit Desk API.
+
+    Only successful responses consume credits. The last call's metering info is
+    available as client.last_receipt_id and client.credits_remaining.
+    """
+
+    def __init__(self, api_key, base_url=DEFAULT_BASE_URL, timeout=30):
+        if not api_key or not api_key.startswith("vbd_"):
+            raise ValueError("Provide a VBD API key (vbd_sbx_... or vbd_live_...). Free keys: /developers/signup")
+        self._session = requests.Session()
+        self._session.headers.update({
+            "Authorization": f"Bearer {api_key}",
+            "User-Agent": f"vbd-python/{_VERSION}",
+        })
+        self._base = base_url.rstrip("/")
+        self._timeout = timeout
+        self.last_receipt_id = None
+        self.credits_remaining = None
+
+    def _get(self, path, params=None):
+        r = self._session.get(f"{self._base}/api/v1{path}", params=params or {}, timeout=self._timeout)
+        self.last_receipt_id = r.headers.get("X-Receipt-Id")
+        remaining = r.headers.get("X-Credits-Remaining")
+        self.credits_remaining = int(remaining) if remaining is not None else self.credits_remaining
+        if r.status_code >= 400:
+            try:
+                detail = r.json().get("detail", r.text[:200])
+            except ValueError:
+                detail = r.text[:200]
+            raise VBDError(r.status_code, detail)
+        return r.json()
+
+    # Conditions
+    def search_conditions(self, q="", body_system=None, limit=25, offset=0):
+        params = {"q": q, "limit": limit, "offset": offset}
+        if body_system:
+            params["body_system"] = body_system
+        return self._get("/conditions", params)
+
+    def get_condition(self, slug):
+        return self._get(f"/conditions/{slug}")
+
+    # Diagnostic codes
+    def search_diagnostic_codes(self, q="", limit=25, offset=0):
+        return self._get("/diagnostic-codes", {"q": q, "limit": limit, "offset": offset})
+
+    def get_diagnostic_code(self, code):
+        return self._get(f"/diagnostic-codes/{code}")
+
+    # VA forms
+    def search_forms(self, q="", limit=25, offset=0):
+        return self._get("/forms", {"q": q, "limit": limit, "offset": offset})
+
+    def get_form(self, form_name):
+        return self._get(f"/forms/{form_name}")
+
+    # State benefits
+    def list_states(self):
+        return self._get("/state-benefits")
+
+    def get_state_benefits(self, state, category=None):
+        params = {"category": category} if category else None
+        return self._get(f"/state-benefits/{state}", params)
+
+    # Account
+    def usage(self):
+        return self._get("/usage")
+
+    # Fuzzy resolution (2 credits)
+    def resolve(self, q, type=None):
+        """Resolve messy text (misspellings ok) to canonical VBD IDs with confidence scores."""
+        params = {"q": q}
+        if type:
+            params["type"] = type
+        return self._get("/enrich", params)