brk-client 0.1.0a2__tar.gz → 0.1.0a3__tar.gz

{brk_client-0.1.0a2 → brk_client-0.1.0a3}/.gitignore

@@ -17,6 +17,7 @@ _*
 /*.py
 /api.json
 /*.json
+/*.html
 
 # Logs
 *.log*

brk_client-0.1.0a3/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: brk-client
+Version: 0.1.0a3
+Summary: Python client for the Bitcoin Research Kit
+Project-URL: Homepage, https://bitcoinresearchkit.org
+Project-URL: Repository, https://github.com/bitcoinresearchkit/brk
+License-Expression: MIT
+Keywords: analytics,bitcoin,blockchain,on-chain
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# brk-client
+
+Python client for the [Bitcoin Research Kit](https://github.com/bitcoinresearchkit/brk) API.
+
+[PyPI](https://pypi.org/project/brk-client/) | [API Reference](https://github.com/bitcoinresearchkit/brk/blob/main/packages/brk_client/DOCS.md)
+
+## Installation
+
+```bash
+pip install brk-client
+# or
+uv add brk-client
+```
+
+## Quick Start
+
+```python
+from brk_client import BrkClient
+
+# Use the free public API or your own instance
+client = BrkClient("https://bitview.space")
+
+# Blockchain data (mempool.space compatible)
+block = client.get_block_by_height(800000)
+tx = client.get_tx("abc123...")
+address = client.get_address("bc1q...")
+
+# Metrics API - typed, chainable
+prices = client.metrics.price.usd.split.close \
+    .by.dateindex() \
+    .tail(30) \
+    .fetch()  # Last 30 items
+
+# Generic metric fetching
+data = client.get_metric("price_close", "dateindex", -30)
+```
+
+## API
+
+```python
+# Range methods
+.head(n)   # First n items
+.tail(n)   # Last n items
+.fetch()   # Execute the request
+```
+
+## Configuration
+
+```python
+client = BrkClient("https://bitview.space", timeout=60.0)
+```

brk_client-0.1.0a3/README.md

@@ -0,0 +1,51 @@
+# brk-client
+
+Python client for the [Bitcoin Research Kit](https://github.com/bitcoinresearchkit/brk) API.
+
+[PyPI](https://pypi.org/project/brk-client/) | [API Reference](https://github.com/bitcoinresearchkit/brk/blob/main/packages/brk_client/DOCS.md)
+
+## Installation
+
+```bash
+pip install brk-client
+# or
+uv add brk-client
+```
+
+## Quick Start
+
+```python
+from brk_client import BrkClient
+
+# Use the free public API or your own instance
+client = BrkClient("https://bitview.space")
+
+# Blockchain data (mempool.space compatible)
+block = client.get_block_by_height(800000)
+tx = client.get_tx("abc123...")
+address = client.get_address("bc1q...")
+
+# Metrics API - typed, chainable
+prices = client.metrics.price.usd.split.close \
+    .by.dateindex() \
+    .tail(30) \
+    .fetch()  # Last 30 items
+
+# Generic metric fetching
+data = client.get_metric("price_close", "dateindex", -30)
+```
+
+## API
+
+```python
+# Range methods
+.head(n)   # First n items
+.tail(n)   # Last n items
+.fetch()   # Execute the request
+```
+
+## Configuration
+
+```python
+client = BrkClient("https://bitview.space", timeout=60.0)
+```