qtsurfer-api-client 0.98.0__tar.gz

qtsurfer_api_client-0.98.0/.gitignore

@@ -0,0 +1,38 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+wheels/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Tooling caches
+.ruff_cache/
+.mypy_cache/
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Editor / OS
+.idea/
+.vscode/
+.DS_Store
+*.swp
+
+# Codegen scratch
+/tmp/qtsurfer-client-gen/
+
+# OpenAPI spec is fetched by scripts/regenerate.sh, not committed
+openapi.yaml

qtsurfer_api_client-0.98.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a
+      fee for, acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Wualabs LTD
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

qtsurfer_api_client-0.98.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: qtsurfer-api-client
+Version: 0.98.0
+Summary: Auto-generated Python client for the QTSurfer API.
+Project-URL: Homepage, https://github.com/QTSurfer/api-client-python
+Project-URL: Repository, https://github.com/QTSurfer/api-client-python
+Project-URL: Issues, https://github.com/QTSurfer/api-client-python/issues
+Project-URL: OpenAPI Spec, https://github.com/QTSurfer/qtsurfer-api
+Project-URL: SDK (Java), https://github.com/QTSurfer/sdk-java
+Project-URL: SDK (TypeScript), https://github.com/QTSurfer/sdk-ts
+Author-email: Manuel Polo <mrmx@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: api,backtest,client,openapi,qtsurfer,trading
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: httpx<1,>=0.23
+Requires-Dist: python-dateutil>=2.8.0
+Description-Content-Type: text/markdown
+
+<h1 align="center">QTSurfer API Client · Python</h1>
+
+<p align="center">
+  <a href="https://github.com/QTSurfer/api-client-python/actions/workflows/ci.yml"><img src="https://github.com/QTSurfer/api-client-python/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://pypi.org/project/qtsurfer-api-client/"><img src="https://img.shields.io/pypi/v/qtsurfer-api-client.svg" alt="PyPI"></a>
+  <a href="https://pypi.org/project/qtsurfer-api-client/"><img src="https://img.shields.io/pypi/pyversions/qtsurfer-api-client.svg" alt="Python versions"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a>
+</p>
+
+<p align="center">
+  Auto-generated Python client for the <a href="https://github.com/QTSurfer/qtsurfer-api">QTSurfer API</a>, built from the OpenAPI 3.1 spec with <a href="https://github.com/openapi-generators/openapi-python-client">openapi-python-client</a> on top of <a href="https://www.python-httpx.org/">httpx</a>.
+</p>
+
+<p align="center">
+  <code>pip install qtsurfer-api-client</code>
+</p>
+
+---
+
+Intentionally thin: one function per endpoint, 1:1 with the spec. For workflow orchestration (polling, retries, domain objects, unified errors), use [`qtsurfer-sdk`](https://github.com/QTSurfer/sdk-python) (coming soon).
+
+- **Sync-first, httpx-powered** — same call site shape as the Java/TS siblings.
+- **Spec-driven** — generated sources fetched from [`QTSurfer/qtsurfer-api`](https://github.com/QTSurfer/qtsurfer-api) by `scripts/regenerate.sh`.
+- **Fully typed** — `py.typed` marker, `mypy --strict` clean (consumers see precise types for every request/response).
+- **Python 3.11+** — modern type hints, no compat shims.
+
+## Installation
+
+```bash
+pip install qtsurfer-api-client
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add qtsurfer-api-client
+```
+
+## Quick start
+
+```python
+import os
+
+from qtsurfer.api.client import AuthenticatedClient
+from qtsurfer.api.client.api.exchange import get_exchanges, get_instruments
+
+client = AuthenticatedClient(
+    base_url="https://api.qtsurfer.com/v1",
+    token=os.environ["QTSURFER_TOKEN"],
+)
+
+exchanges = get_exchanges.sync(client=client)
+for ex in exchanges or []:
+    print(ex.id, ex.name)
+
+instruments = get_instruments.sync(client=client, exchange_id="binance")
+print(f"{len(instruments.data)} instruments on binance ({instruments.meta.segment.value})")
+```
+
+### API key → JWT
+
+Every endpoint above expects a short-lived JWT in the `Authorization: Bearer …`
+header. Exchange a long-lived API key for one via `auth`:
+
+```python
+import os
+
+from qtsurfer.api.client import AuthenticatedClient
+from qtsurfer.api.client.api.auth import auth
+
+# AuthenticatedClient also drives the apikey header — set prefix="" so it
+# sends `X-API-Key: <key>` instead of `Authorization: Bearer <key>`.
+apikey_client = AuthenticatedClient(
+    base_url="https://api.qtsurfer.com/v1",
+    token=os.environ["QTSURFER_APIKEY"],
+    prefix="",
+    auth_header_name="X-API-Key",
+)
+
+token_response = auth.sync(client=apikey_client)
+jwt = token_response.access_token  # use this in subsequent calls
+```
+
+For production use, prefer the [`qtsurfer-sdk`](https://github.com/QTSurfer/sdk-python)
+`auth(apikey)` helper — it handles token refresh, env-var pickup
+(`QTSURFER_APIKEY`), and pluggable token storage so callers don't reinvent any
+of it on top of the raw client.
+
+Each generated endpoint module exposes four entrypoints:
+
+| Function | Returns |
+| --- | --- |
+| `sync(...)` | parsed model (or `None` on a defined error response) |
+| `sync_detailed(...)` | full `Response[...]` (status, headers, parsed, content) |
+| `asyncio(...)` | parsed model, awaitable |
+| `asyncio_detailed(...)` | full `Response[...]`, awaitable |
+
+## API surface
+
+| Module | Operation | Method · Path |
+| --- | --- | --- |
+| `api.auth` | `auth` | `POST /auth/token` — exchange API key for a short-lived JWT |
+| `api.exchange` | `get_exchanges` | `GET /exchanges` |
+| `api.exchange` | `get_instruments` | `GET /exchange/{exchangeId}/instruments` (default `spot` segment) |
+| `api.exchange` | `get_segment_instruments` | `GET /exchange/{exchangeId}/{segment}/instruments` |
+| `api.exchange` | `get_exchange_tickers_hour` | `GET /exchange/{exchangeId}/tickers/{base}/{quote}` |
+| `api.exchange` | `get_exchange_klines_hour` | `GET /exchange/{exchangeId}/klines/{base}/{quote}` |
+| `api.strategy` | `get_strategy_status` | `GET /strategy/{strategyId}` |
+| `api.backtesting` | `prepare_backtesting` | `POST /backtesting/prepare` |
+| `api.backtesting` | `get_preparation_status` | `GET /backtesting/prepare/{jobId}` |
+| `api.backtesting` | `execute_backtesting` | `POST /backtesting/execute` |
+| `api.backtesting` | `cancel_execution` | `POST /backtesting/execute/{jobId}/cancel` |
+| `api.backtesting` | `get_execution_result` | `GET /backtesting/execute/{jobId}` |
+
+> Exact module/function names are produced from `operationId` in the OpenAPI spec. Run `scripts/regenerate.sh` to refresh and check `src/qtsurfer/api/client/_generated/api/` for the authoritative listing.
+
+All generated model types (`Exchange`, `InstrumentDetail`, `InstrumentCoverage`, `CoverageWindow`, `JobState`, `PrepareJobState`, `BacktestJobResult`, `ResultMap`, `ResponseError`, …) live under `qtsurfer.api.client.models`. `get_instruments`/`get_segment_instruments` return an `InstrumentListResponse` (HAL envelope: `data` + `meta` + `_links`), not a bare list — each `InstrumentDetail.coverage` carries per-data-type `CoverageWindow`s instead of flat `dataFrom`/`dataTo`. A single-instrument `get_preparation_status` returns a `PrepareJobState` — always terminal (`status: Completed`), with a `coverage_ratio` and a per-hour `hours_without_data` breakdown to act on instead of polling.
+
+> **`POST /strategy` (`postStrategy`)** is currently omitted by the generator because the spec declares its request body as `text/plain` and `openapi-python-client` only emits JSON / form / multipart bodies. Call it directly via the underlying `httpx` client (`client.get_httpx_client().post("/strategy", content=src, headers={"Content-Type": "text/plain"})`) until the spec is restructured.
+
+### Binary downloads (`/exchange/{ex}/tickers|klines/{base}/{quote}`)
+
+These endpoints return raw [Lastra](https://github.com/QTSurfer/lastra-java) bytes (default) or Parquet (`format=parquet`). The generated `sync()` helpers parse the response body as JSON and will raise on binary payloads; use `sync_detailed()` and read `response.content` directly:
+
+```python
+from qtsurfer.api.client import AuthenticatedClient
+from qtsurfer.api.client.api.exchange import get_exchange_tickers_hour
+
+client = AuthenticatedClient(base_url="https://api.qtsurfer.com/v1", token=token)
+
+response = get_exchange_tickers_hour.sync_detailed(
+    client=client,
+    exchange_id="binance",
+    base="BTC",
+    quote="USDT",
+    hour="2026-01-15T10",
+)
+with open("BTC_USDT_2026-01-15_h10.lastra", "wb") as f:
+    f.write(response.content)
+```
+
+For very large segments, drop down to the underlying `httpx.Client` (`client.get_httpx_client()`) and stream:
+
+```python
+with client.get_httpx_client().stream(
+    "GET",
+    "/exchange/binance/klines/BTC/USDT",
+    params={"hour": "2026-01-15T10", "format": "parquet"},
+) as r:
+    r.raise_for_status()
+    with open("out.parquet", "wb") as f:
+        for chunk in r.iter_bytes():
+            f.write(chunk)
+```
+
+## Configuring the client
+
+Both `Client` and `AuthenticatedClient` accept the standard hooks of the upstream generator:
+
+```python
+from qtsurfer.api.client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://api.qtsurfer.com/v1",
+    token=token,
+    timeout=httpx.Timeout(30.0),
+    verify_ssl=True,
+    headers={"X-Request-Id": "..."},
+    raise_on_unexpected_status=True,
+)
+```
+
+Need per-call customisation (e.g. swap the underlying `httpx.Client` for one with a custom transport)? Use `client.with_httpx_client(my_httpx_client)` or `client.set_httpx_client(...)`.
+
+## Regenerating the client
+
+The `src/qtsurfer/api/client/_generated/` directory is a committed build artifact produced from the OpenAPI spec hosted at [`QTSurfer/qtsurfer-api`](https://github.com/QTSurfer/qtsurfer-api/blob/main/openapi.yaml). Never hand-edit it.
+
+```bash
+uv sync                    # install pinned dev deps
+./scripts/regenerate.sh    # fetch spec + regenerate + sync pyproject version
+uv run ruff check src/ tests/
+uv run mypy src/
+uv run pytest -v
+```
+
+Generator configuration lives in `codegen.config.yaml`. The spec URL is hard-coded in `scripts/regenerate.sh`; point it at a tag/commit for fully reproducible builds.
+
+## Development
+
+| Command | Description |
+| ------ | ----------- |
+| `uv sync` | Install dependencies from `uv.lock` |
+| `./scripts/regenerate.sh` | Re-fetch spec + regenerate client |
+| `uv run ruff check src/ tests/` | Lint |
+| `uv run ruff format src/ tests/` | Format |
+| `uv run mypy src/` | Type-check (`--strict`) |
+| `uv run pytest -v` | Run tests |
+| `uv run python -m build` | Build wheel + sdist into `dist/` |
+
+## Versioning
+
+`pyproject.toml`'s `version` field is kept in lockstep with the `info.version` of the OpenAPI spec by `scripts/regenerate.sh`. Tags pushed to `main` (`vX.Y.Z`) trigger the PyPI publish workflow via OIDC trusted publishing.
+
+## License
+
+Apache-2.0 — see [LICENSE](./LICENSE).