{"id":44232218,"url":"https://github.com/terrylica/crypto-kline-vision-data","last_synced_at":"2026-03-03T20:12:07.900Z","repository":{"id":336561633,"uuid":"975734023","full_name":"terrylica/crypto-kline-vision-data","owner":"terrylica","description":"High-performance Python 3.13 market data via Failover Control Protocol (FCP): Cache \u003e Vision API (S3) \u003e REST. Binance OHLCV: Spot, USDT-M \u0026 Coin-M Futures. Polars internals, pandas/Polars API. Arrow IPC mmap cache (sub-ms), gap detection, rate-limit-aware retry, checksums. uv add crypto-kline-vision-data | from ckvd import CryptoKlineVisionData","archived":false,"fork":false,"pushed_at":"2026-02-20T20:10:15.000Z","size":6974,"stargazers_count":0,"open_issues_count":9,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-21T01:51:09.113Z","etag":null,"topics":["arrow","binance","binance-api","cache","candlestick","crypto","data-pipeline","failover","futures","market-data","ohlcv","pandas","polars","pypi","python","rate-limiting","s3","vision-api"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/crypto-kline-vision-data/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/terrylica.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-30T20:07:16.000Z","updated_at":"2026-02-20T20:10:17.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/terrylica/crypto-kline-vision-data","commit_stats":null,"previous_names":["terrylica/data-source-manager","terrylica/crypto-kline-vision-data"],"tags_count":32,"template":false,"template_full_name":null,"purl":"pkg:github/terrylica/crypto-kline-vision-data","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrylica%2Fcrypto-kline-vision-data","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrylica%2Fcrypto-kline-vision-data/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrylica%2Fcrypto-kline-vision-data/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrylica%2Fcrypto-kline-vision-data/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terrylica","download_url":"https://codeload.github.com/terrylica/crypto-kline-vision-data/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terrylica%2Fcrypto-kline-vision-data/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30058098,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T18:21:05.932Z","status":"ssl_error","status_checked_at":"2026-03-03T18:20:59.341Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arrow","binance","binance-api","cache","candlestick","crypto","data-pipeline","failover","futures","market-data","ohlcv","pandas","polars","pypi","python","rate-limiting","s3","vision-api"],"created_at":"2026-02-10T07:11:36.798Z","updated_at":"2026-03-03T20:12:07.871Z","avatar_url":"https://github.com/terrylica.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Crypto Kline Vision Data\n\nHigh-performance market data integration with Failover Control Protocol (FCP).\n\n**Package**: `crypto-kline-vision-data` | **Import**: `ckvd` | **Python**: 3.13\n\n[![GitHub Release](https://img.shields.io/github/v/release/terrylica/crypto-kline-vision-data)](https://github.com/terrylica/crypto-kline-vision-data/releases)\n\n## Features\n\n- **Failover Control Protocol (FCP)**: Cache (~1ms) → Vision API (~1-5s) → REST API (~100-500ms) — automatic failover, retry, and gap detection\n- **Apache Arrow Cache**: Memory-mapped local cache for instant repeated access\n- **Binance Vision API**: Bulk historical data from AWS S3 (no rate limits, ~48h delay)\n- **Binance REST API**: Real-time data with built-in rate limit handling ([Spot](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints), [USDS-M Futures](https://developers.binance.com/docs/derivatives/usds-margined-futures/general-info), [Coin-M Futures](https://developers.binance.com/docs/derivatives/coin-margined-futures/general-info))\n- **Polars Engine**: Internal Polars LazyFrames + streaming; pandas or Polars output at API boundary\n- **AI Agent Introspection**: `__probe__.py` module for stateless API discovery\n- **Security**: Symbol validation (CWE-22 path traversal prevention)\n- **Machine-Parseable Errors**: All exceptions carry `.details` dict\n\n## Quick Start\n\n```bash\ngit clone https://github.com/terrylica/crypto-kline-vision-data.git\ncd crypto-kline-vision-data\nuv sync --dev\n```\n\n```python\nfrom ckvd import CryptoKlineVisionData, DataProvider, MarketType, Interval\nfrom datetime import datetime, timedelta, timezone\n\nmanager = CryptoKlineVisionData.create(DataProvider.BINANCE, MarketType.FUTURES_USDT)\n\nend = datetime.now(timezone.utc)\nstart = end - timedelta(days=7)\n\ndf = manager.get_data(\"BTCUSDT\", start, end, Interval.HOUR_1)\nprint(f\"Loaded {len(df)} bars\")\nmanager.close()\n```\n\nOr as a Git dependency in your `pyproject.toml`:\n\n```toml\ndependencies = [\n    \"crypto-kline-vision-data @ git+https://github.com/terrylica/crypto-kline-vision-data.git\"\n]\n```\n\n## For Claude Code Users\n\nThis repository is optimized for [Claude Code](https://docs.anthropic.com/en/docs/claude-code) with a **hub-and-spoke CLAUDE.md architecture**. When Claude Code opens any directory, it automatically loads that directory's `CLAUDE.md` — giving it domain-specific context, conventions, and deep links to related documentation.\n\n**Start here**: [`CLAUDE.md`](CLAUDE.md) (root hub) — then Claude Code discovers everything else autonomously.\n\n### Hub-and-Spoke Architecture\n\n```\nCLAUDE.md (root hub)\n├── src/CLAUDE.md         → Package structure, FCP, exceptions, __probe__, security\n├── tests/CLAUDE.md       → Test commands, markers, fixtures, mocking patterns\n├── docs/CLAUDE.md        → ADRs, skills, benchmarks, troubleshooting\n├── examples/CLAUDE.md    → Example conventions, NDJSON telemetry schema\n├── scripts/CLAUDE.md     → Dev scripts, mise tasks, cache tools\n└── playground/CLAUDE.md  → Experimental prototypes\n```\n\nEach spoke contains only the context relevant to that directory. Claude Code loads them on demand — no context window waste.\n\n### What Claude Code Gets\n\n- **Skills** in `docs/skills/` — progressive disclosure guides for usage, testing, research, FCP monitoring\n- **Agents** in `.claude/agents/` — specialized subagents (API reviewer, test writer, FCP debugger, silent failure hunter)\n- **Commands** in `.claude/commands/` — `/review-ckvd`, `/feature-dev`\n- **Full API surface** via `from ckvd.__probe__ import discover_api` — JSON-serializable metadata for agent introspection\n\n### Tips for Working with Claude Code\n\n1. **Just ask** — Claude Code reads the relevant CLAUDE.md files automatically when you work in a directory\n2. **Use skills** — ask Claude to \"fetch BTCUSDT data\" or \"run tests\" and it discovers the right patterns\n3. **Use agents** — `@silent-failure-hunter` to audit code, `@test-writer` to generate tests\n4. **Use probe** — `from ckvd.__probe__ import discover_api` for programmatic API discovery\n\n## Examples\n\n```bash\n# Via mise tasks\nmise run demo:quickstart          # Minimal FCP usage\nmise run demo:features            # Feature engineering pipeline\nmise run demo:cache               # Cache toggle mechanisms\nmise run demo:logging             # Logging configuration\nmise run demo:datetime            # Timezone handling\nmise run demo:one-second          # 1s interval (SPOT only)\nmise run demo:lazy                # Lazy initialization\n\n# Or directly\nuv run -p 3.13 python examples/quick_start.py\n```\n\nAll examples emit **NDJSON telemetry** to `examples/logs/events.jsonl`. See [examples/CLAUDE.md](examples/CLAUDE.md) for schema and parsing.\n\n## API Reference\n\n### Core API\n\n```python\nfrom ckvd import CryptoKlineVisionData, DataProvider, MarketType, Interval\n\n# Manager-based (recommended)\nmanager = CryptoKlineVisionData.create(DataProvider.BINANCE, MarketType.FUTURES_USDT)\ndf = manager.get_data(\"BTCUSDT\", start, end, Interval.HOUR_1)\nmanager.close()\n\n# High-level function\nfrom ckvd import fetch_market_data, ChartType\ndf, elapsed, count = fetch_market_data(\n    provider=DataProvider.BINANCE, market_type=MarketType.SPOT,\n    chart_type=ChartType.KLINES, symbol=\"BTCUSDT\",\n    interval=Interval.HOUR_1, start_time=start, end_time=end\n)\n```\n\n### Market Types and Symbols\n\n| Market Type    | Symbol Format    | Example     |\n| -------------- | ---------------- | ----------- |\n| `SPOT`         | `{BASE}{QUOTE}`  | BTCUSDT     |\n| `FUTURES_USDT` | `{BASE}{QUOTE}`  | BTCUSDT     |\n| `FUTURES_COIN` | `{BASE}USD_PERP` | BTCUSD_PERP |\n\n### Output Formats\n\n```python\n# Default: pandas DataFrame (backward compatible)\ndf = manager.get_data(\"BTCUSDT\", start, end, Interval.HOUR_1)\n\n# Opt-in: Polars DataFrame (zero-copy, faster)\ndf = manager.get_data(\"BTCUSDT\", start, end, Interval.HOUR_1, return_polars=True)\n```\n\n### Error Handling\n\n```python\nfrom ckvd.utils.for_core.rest_exceptions import RateLimitError, RestAPIError\nfrom ckvd.utils.for_core.vision_exceptions import VisionAPIError\n\ntry:\n    df = manager.get_data(...)\nexcept RateLimitError as e:\n    print(f\"Rate limited, retry after {e.retry_after}s. Details: {e.details}\")\nexcept (RestAPIError, VisionAPIError) as e:\n    print(f\"Error: {e}. Details: {e.details}\")\n```\n\n### Environment Variables\n\n| Variable                 | Purpose                      | Default |\n| ------------------------ | ---------------------------- | ------- |\n| `CKVD_LOG_LEVEL`         | Log level (DEBUG/INFO/ERROR) | ERROR   |\n| `CKVD_ENABLE_CACHE`      | Enable/disable cache         | true    |\n| `CKVD_USE_POLARS_OUTPUT` | Zero-copy Polars output      | false   |\n\n## Development\n\n```bash\nuv sync --dev                    # Install dependencies\nmise trust                       # Load environment\nuv run -p 3.13 pytest tests/unit/ -v   # Run tests (399 passing)\nuv run -p 3.13 ruff check --fix .      # Lint\n```\n\nSee [CLAUDE.md](CLAUDE.md) for full development conventions, commit trailers, and release workflow.\n\n## Documentation\n\n| Resource                                           | Purpose                                 |\n| -------------------------------------------------- | --------------------------------------- |\n| [CLAUDE.md](CLAUDE.md)                             | Root hub — start here for Claude Code   |\n| [docs/INDEX.md](docs/INDEX.md)                     | Documentation navigation                |\n| [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) | Common issues and solutions             |\n| [docs/GLOSSARY.md](docs/GLOSSARY.md)               | Domain terminology                      |\n| [examples/](examples/)                             | Runnable examples with NDJSON telemetry |\n| [CHANGELOG.md](CHANGELOG.md)                       | Release history (auto-generated)        |\n\n## License\n\nMIT License — See [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterrylica%2Fcrypto-kline-vision-data","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterrylica%2Fcrypto-kline-vision-data","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterrylica%2Fcrypto-kline-vision-data/lists"}