Metadata-Version: 2.4
Name: kricket-client
Version: 0.1.0
Summary: Python client for Kricket Protocol: DeFi intelligence and execution suite
Project-URL: Homepage, https://github.com/VYLTH/kricket
Project-URL: Repository, https://github.com/VYLTH/kricket
Author: VYLTH
License-Expression: MIT
License-File: LICENSE
Keywords: api-client,defi,kricket,solana,web3
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27.0
Requires-Dist: pydantic>=2.0.0
Description-Content-Type: text/markdown

# kricket-client

Async Python client for the [Kricket Protocol](https://cricket.vylth.com) — DeFi intelligence APIs for rug detection, wallet profiling, price feeds, smart contract analysis, and notifications.

Requires Python 3.10+. All methods are async.

## Installation

```bash
pip install kricket-client
```

## Quick Start

```python
import asyncio
from kricket_client import KricketClient

async def main():
    async with KricketClient(api_key="your-api-key") as kricket:
        # Scan a token for rug-pull risk
        result = await kricket.mantis.scan("TOKEN_ADDRESS")
        print(result.risk_score.rating)  # 'low' | 'moderate' | 'high' | 'critical'
        print(result.risk_score.score)   # 0–100

        # Get a wallet intelligence profile
        wallet = await kricket.firefly.get_wallet("WALLET_ADDRESS")
        print(wallet.score, wallet.style, wallet.win_rate)

asyncio.run(main())
```

## Clients

| Client | Description | Key Methods |
|--------|-------------|-------------|
| `kricket.mantis` | Rug-pull detection & token risk scoring | `scan(token)`, `get_score(token)`, `add_to_watchlist(tokens)`, `get_watchlist()` |
| `kricket.firefly` | Wallet intelligence & smart money signals | `get_wallet(address)`, `get_signals()`, `get_leaderboard()`, `track(address)` |
| `kricket.pulse` | Unified price feeds (CEX + DEX) | `get_price(symbol)`, `get_spread(symbol)` |
| `kricket.chirps` | Notification channel management | `list_channels()`, `create_channel(config)`, `delete_channel(id)` |
| `kricket.debugger` | Smart contract vulnerability analysis | `analyze(source, language)` |

## Configuration

```python
from kricket_client import KricketClient, KricketConfig

config = KricketConfig(
    api_key="your-api-key",
    base_url="https://api-cricket.vylth.com/api/kricket",  # optional override
    timeout=30.0,  # seconds, default 30
)
kricket = KricketClient(config)
```

## Error Handling

```python
from kricket_client import KricketError

try:
    result = await kricket.mantis.scan(token)
except KricketError as e:
    print(e.code, e.message, e.status)
```

## Full Docs

[cricket.vylth.com/docs](https://cricket.vylth.com/docs)
