Skip to content

Commit 0a4121d

Browse files
committed
Update docs to mounted surface; split top-level-import surface test
docs/{telegram,naver-trend,async}.md showed the removed standalone imports (from datamaxi import Telegram, from datamaxi.aio import AsyncTelegram, ...) — repoint to maxi.telegram / client.telegram. Split the not-top-level-importable assertion per resource file.
1 parent 5555d3d commit 0a4121d

5 files changed

Lines changed: 22 additions & 18 deletions

File tree

docs/async.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,9 @@ finally:
5555

5656
- Every data and discovery method is a coroutine — `await` it (e.g.
5757
`await client.cex.candle.exchanges(market="spot")`).
58-
- Telegram and Naver have standalone async clients, `AsyncTelegram` and
59-
`AsyncNaver`, also imported from `datamaxi.aio` and used the same way (async
60-
context managers, awaited methods). See the [Telegram](telegram.md) and
61-
[Naver Trend](naver-trend.md) pages for tabbed examples.
58+
- Telegram and Naver are reached via `client.telegram` and `client.naver`. See
59+
the [Telegram](telegram.md) and [Naver Trend](naver-trend.md) pages for tabbed
60+
examples.
6261

6362
## Pagination
6463

docs/naver-trend.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Search trend data for South Korea via Naver.
77
<details markdown="1"><summary>Sync</summary>
88

99
```python
10-
from datamaxi import Naver
10+
from datamaxi import Datamaxi
1111

12-
naver = Naver(api_key="YOUR_API_KEY")
12+
naver = Datamaxi(api_key="YOUR_API_KEY").naver
1313

1414
symbols = naver.symbols()
1515
trend = naver.trend(symbol="BTC")
@@ -21,13 +21,13 @@ trend = naver.trend(symbol="BTC")
2121

2222
```python
2323
import asyncio
24-
from datamaxi.aio import AsyncNaver
24+
from datamaxi.aio import AsyncDatamaxi
2525

2626

2727
async def main():
28-
async with AsyncNaver(api_key="YOUR_API_KEY") as naver:
29-
symbols = await naver.symbols()
30-
trend = await naver.trend(symbol="BTC")
28+
async with AsyncDatamaxi(api_key="YOUR_API_KEY") as client:
29+
symbols = await client.naver.symbols()
30+
trend = await client.naver.trend(symbol="BTC")
3131

3232

3333
asyncio.run(main())

docs/telegram.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Telegram channel metadata and message history.
77
<details markdown="1"><summary>Sync</summary>
88

99
```python
10-
from datamaxi import Telegram
10+
from datamaxi import Datamaxi
1111

12-
telegram = Telegram(api_key="YOUR_API_KEY")
12+
telegram = Datamaxi(api_key="YOUR_API_KEY").telegram
1313

1414
channels, _ = telegram.channels(category="korean", limit=50)
1515
messages, next_request = telegram.messages(channel_name="yunlog_announcement", limit=50)
@@ -23,13 +23,13 @@ more_messages, _ = next_request()
2323

2424
```python
2525
import asyncio
26-
from datamaxi.aio import AsyncTelegram
26+
from datamaxi.aio import AsyncDatamaxi
2727

2828

2929
async def main():
30-
async with AsyncTelegram(api_key="YOUR_API_KEY") as telegram:
31-
channels, _ = await telegram.channels(category="korean", limit=50)
32-
messages, next_request = await telegram.messages(
30+
async with AsyncDatamaxi(api_key="YOUR_API_KEY") as client:
31+
channels, _ = await client.telegram.channels(category="korean", limit=50)
32+
messages, next_request = await client.telegram.messages(
3333
channel_name="yunlog_announcement", limit=50
3434
)
3535

tests/test_naver.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,9 @@ def test_naver_mounted_trend_works():
8585
df = maxi.naver.trend("BTC")
8686
assert isinstance(df, pd.DataFrame)
8787
assert len(df) == 2
88+
89+
90+
def test_standalone_naver_not_top_level_importable():
91+
import datamaxi
92+
93+
assert not hasattr(datamaxi, "Naver")

tests/test_telegram.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,7 @@ def test_telegram_mounted_messages_work():
128128
assert callable(next_request)
129129

130130

131-
def test_standalone_clients_not_top_level_importable():
131+
def test_standalone_telegram_not_top_level_importable():
132132
import datamaxi
133133

134134
assert not hasattr(datamaxi, "Telegram")
135-
assert not hasattr(datamaxi, "Naver")

0 commit comments

Comments
 (0)