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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. {brk_client-0.1.0 → brk_client-0.1.0a3}/.gitignore +1 -7
  2. brk_client-0.1.0a3/.python-version +1 -0
  3. {brk_client-0.1.0 → brk_client-0.1.0a3}/PKG-INFO +18 -10
  4. {brk_client-0.1.0 → brk_client-0.1.0a3}/README.md +15 -5
  5. {brk_client-0.1.0 → brk_client-0.1.0a3}/brk_client/__init__.py +584 -920
  6. {brk_client-0.1.0 → brk_client-0.1.0a3}/pyproject.toml +3 -5
  7. {brk_client-0.1.0 → brk_client-0.1.0a3}/tests/test_basic.py +1 -1
  8. {brk_client-0.1.0 → brk_client-0.1.0a3}/uv.lock +13 -235
  9. brk_client-0.1.0/.python-version +0 -1
  10. {brk_client-0.1.0 → brk_client-0.1.0a3}/pydoc-markdown.yml +0 -0
  11. {brk_client-0.1.0 → brk_client-0.1.0a3}/tests/test_tree.py +0 -0
{brk_client-0.1.0 → brk_client-0.1.0a3}/.gitignore RENAMED
@@ -6,7 +6,6 @@ target
6
6
  websites/dist
7
7
  bridge/
8
8
  /ids.txt
9
- rust_out
10
9
 
11
10
  # Copies
12
11
  *\ copy*
@@ -16,14 +15,9 @@ _*
16
15
  !__*.py
17
16
  /*.md
18
17
  /*.py
18
+ /api.json
19
19
  /*.json
20
20
  /*.html
21
- /research
22
- /filter_*
23
- /heatmaps*
24
- /oracle*
25
- /playground
26
- /*.txt
27
21
 
28
22
  # Logs
29
23
  *.log*
brk_client-0.1.0a3/.python-version ADDED
@@ -0,0 +1 @@
1
+ 3.12
{brk_client-0.1.0 → brk_client-0.1.0a3}/PKG-INFO RENAMED
@@ -1,30 +1,26 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: brk-client
3
- Version: 0.1.0
3
+ Version: 0.1.0a3
4
4
  Summary: Python client for the Bitcoin Research Kit
5
5
  Project-URL: Homepage, https://bitcoinresearchkit.org
6
6
  Project-URL: Repository, https://github.com/bitcoinresearchkit/brk
7
7
  License-Expression: MIT
8
8
  Keywords: analytics,bitcoin,blockchain,on-chain
9
- Classifier: Development Status :: 4 - Beta
9
+ Classifier: Development Status :: 3 - Alpha
10
10
  Classifier: Intended Audience :: Developers
11
11
  Classifier: License :: OSI Approved :: MIT License
12
12
  Classifier: Programming Language :: Python :: 3
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
13
  Classifier: Programming Language :: Python :: 3.11
16
14
  Classifier: Programming Language :: Python :: 3.12
17
15
  Classifier: Programming Language :: Python :: 3.13
18
16
  Classifier: Typing :: Typed
19
- Requires-Python: >=3.9
17
+ Requires-Python: >=3.11
20
18
  Description-Content-Type: text/markdown
21
19
 
22
20
  # brk-client
23
21
 
24
22
  Python client for the [Bitcoin Research Kit](https://github.com/bitcoinresearchkit/brk) API.
25
23
 
26
- Requires Python 3.9+. Zero dependencies.
27
-
28
24
  [PyPI](https://pypi.org/project/brk-client/) | [API Reference](https://github.com/bitcoinresearchkit/brk/blob/main/packages/brk_client/DOCS.md)
29
25
 
30
26
  ## Installation
@@ -35,15 +31,12 @@ pip install brk-client
35
31
  uv add brk-client
36
32
  ```
37
33
 
38
- Or just copy [`brk_client/__init__.py`](./brk_client/__init__.py) into your project - it's a single file with no dependencies.
39
-
40
34
  ## Quick Start
41
35
 
42
36
  ```python
43
37
  from brk_client import BrkClient
44
38
 
45
39
  # Use the free public API or your own instance
46
- # Has optional `, timeout=60.0` argument
47
40
  client = BrkClient("https://bitview.space")
48
41
 
49
42
  # Blockchain data (mempool.space compatible)
@@ -60,3 +53,18 @@ prices = client.metrics.price.usd.split.close \
60
53
  # Generic metric fetching
61
54
  data = client.get_metric("price_close", "dateindex", -30)
62
55
  ```
56
+
57
+ ## API
58
+
59
+ ```python
60
+ # Range methods
61
+ .head(n) # First n items
62
+ .tail(n) # Last n items
63
+ .fetch() # Execute the request
64
+ ```
65
+
66
+ ## Configuration
67
+
68
+ ```python
69
+ client = BrkClient("https://bitview.space", timeout=60.0)
70
+ ```
{brk_client-0.1.0 → brk_client-0.1.0a3}/README.md RENAMED
@@ -2,8 +2,6 @@
2
2
 
3
3
  Python client for the [Bitcoin Research Kit](https://github.com/bitcoinresearchkit/brk) API.
4
4
 
5
- Requires Python 3.9+. Zero dependencies.
6
-
7
5
  [PyPI](https://pypi.org/project/brk-client/) | [API Reference](https://github.com/bitcoinresearchkit/brk/blob/main/packages/brk_client/DOCS.md)
8
6
 
9
7
  ## Installation
@@ -14,15 +12,12 @@ pip install brk-client
14
12
  uv add brk-client
15
13
  ```
16
14
 
17
- Or just copy [`brk_client/__init__.py`](./brk_client/__init__.py) into your project - it's a single file with no dependencies.
18
-
19
15
  ## Quick Start
20
16
 
21
17
  ```python
22
18
  from brk_client import BrkClient
23
19
 
24
20
  # Use the free public API or your own instance
25
- # Has optional `, timeout=60.0` argument
26
21
  client = BrkClient("https://bitview.space")
27
22
 
28
23
  # Blockchain data (mempool.space compatible)
@@ -39,3 +34,18 @@ prices = client.metrics.price.usd.split.close \
39
34
  # Generic metric fetching
40
35
  data = client.get_metric("price_close", "dateindex", -30)
41
36
  ```
37
+
38
+ ## API
39
+
40
+ ```python
41
+ # Range methods
42
+ .head(n) # First n items
43
+ .tail(n) # Last n items
44
+ .fetch() # Execute the request
45
+ ```
46
+
47
+ ## Configuration
48
+
49
+ ```python
50
+ client = BrkClient("https://bitview.space", timeout=60.0)
51
+ ```