brk-client 0.1.0a3__tar.gz → 0.1.0b0__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.0a3 → brk_client-0.1.0b0}/.gitignore +7 -1
  2. brk_client-0.1.0b0/.python-version +1 -0
  3. {brk_client-0.1.0a3 → brk_client-0.1.0b0}/PKG-INFO +10 -18
  4. {brk_client-0.1.0a3 → brk_client-0.1.0b0}/README.md +5 -15
  5. {brk_client-0.1.0a3 → brk_client-0.1.0b0}/brk_client/__init__.py +3031 -5064
  6. {brk_client-0.1.0a3 → brk_client-0.1.0b0}/pyproject.toml +5 -3
  7. {brk_client-0.1.0a3 → brk_client-0.1.0b0}/uv.lock +235 -13
  8. brk_client-0.1.0a3/.python-version +0 -1
  9. {brk_client-0.1.0a3 → brk_client-0.1.0b0}/pydoc-markdown.yml +0 -0
  10. {brk_client-0.1.0a3 → brk_client-0.1.0b0}/tests/test_basic.py +0 -0
  11. {brk_client-0.1.0a3 → brk_client-0.1.0b0}/tests/test_tree.py +0 -0
{brk_client-0.1.0a3 → brk_client-0.1.0b0}/.gitignore RENAMED
@@ -6,6 +6,7 @@ target
6
6
  websites/dist
7
7
  bridge/
8
8
  /ids.txt
9
+ rust_out
9
10
 
10
11
  # Copies
11
12
  *\ copy*
@@ -15,9 +16,14 @@ _*
15
16
  !__*.py
16
17
  /*.md
17
18
  /*.py
18
- /api.json
19
19
  /*.json
20
20
  /*.html
21
+ /research
22
+ /filter_*
23
+ /heatmaps*
24
+ /oracle*
25
+ /playground
26
+ /*.txt
21
27
 
22
28
  # Logs
23
29
  *.log*
brk_client-0.1.0b0/.python-version ADDED
@@ -0,0 +1 @@
1
+ 3.9
{brk_client-0.1.0a3 → brk_client-0.1.0b0}/PKG-INFO RENAMED
@@ -1,26 +1,30 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: brk-client
3
- Version: 0.1.0a3
3
+ Version: 0.1.0b0
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 :: 3 - Alpha
9
+ Classifier: Development Status :: 4 - Beta
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
13
15
  Classifier: Programming Language :: Python :: 3.11
14
16
  Classifier: Programming Language :: Python :: 3.12
15
17
  Classifier: Programming Language :: Python :: 3.13
16
18
  Classifier: Typing :: Typed
17
- Requires-Python: >=3.11
19
+ Requires-Python: >=3.9
18
20
  Description-Content-Type: text/markdown
19
21
 
20
22
  # brk-client
21
23
 
22
24
  Python client for the [Bitcoin Research Kit](https://github.com/bitcoinresearchkit/brk) API.
23
25
 
26
+ Requires Python 3.9+. Zero dependencies.
27
+
24
28
  [PyPI](https://pypi.org/project/brk-client/) | [API Reference](https://github.com/bitcoinresearchkit/brk/blob/main/packages/brk_client/DOCS.md)
25
29
 
26
30
  ## Installation
@@ -31,12 +35,15 @@ pip install brk-client
31
35
  uv add brk-client
32
36
  ```
33
37
 
38
+ Or just copy [`brk_client/__init__.py`](./brk_client/__init__.py) into your project - it's a single file with no dependencies.
39
+
34
40
  ## Quick Start
35
41
 
36
42
  ```python
37
43
  from brk_client import BrkClient
38
44
 
39
45
  # Use the free public API or your own instance
46
+ # Has optional `, timeout=60.0` argument
40
47
  client = BrkClient("https://bitview.space")
41
48
 
42
49
  # Blockchain data (mempool.space compatible)
@@ -53,18 +60,3 @@ prices = client.metrics.price.usd.split.close \
53
60
  # Generic metric fetching
54
61
  data = client.get_metric("price_close", "dateindex", -30)
55
62
  ```
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.0a3 → brk_client-0.1.0b0}/README.md RENAMED
@@ -2,6 +2,8 @@
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
+
5
7
  [PyPI](https://pypi.org/project/brk-client/) | [API Reference](https://github.com/bitcoinresearchkit/brk/blob/main/packages/brk_client/DOCS.md)
6
8
 
7
9
  ## Installation
@@ -12,12 +14,15 @@ pip install brk-client
12
14
  uv add brk-client
13
15
  ```
14
16
 
17
+ Or just copy [`brk_client/__init__.py`](./brk_client/__init__.py) into your project - it's a single file with no dependencies.
18
+
15
19
  ## Quick Start
16
20
 
17
21
  ```python
18
22
  from brk_client import BrkClient
19
23
 
20
24
  # Use the free public API or your own instance
25
+ # Has optional `, timeout=60.0` argument
21
26
  client = BrkClient("https://bitview.space")
22
27
 
23
28
  # Blockchain data (mempool.space compatible)
@@ -34,18 +39,3 @@ prices = client.metrics.price.usd.split.close \
34
39
  # Generic metric fetching
35
40
  data = client.get_metric("price_close", "dateindex", -30)
36
41
  ```
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
- ```