qtsurfer-sdk 0.2.0__tar.gz

qtsurfer_sdk-0.2.0/.gitignore

@@ -0,0 +1,26 @@
+# Python build artifacts
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+build/
+dist/
+.eggs/
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# uv / virtual envs
+.venv/
+.python-version
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# pdoc output; hand-written Markdown guides remain tracked.
+docs/*
+!docs/*.md

qtsurfer_sdk-0.2.0/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+All notable changes to `qtsurfer-sdk` are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- `open_dataset_upload(dataset_id)` opens a dataset's current upload session or
+  its next version's session after finalization.
+- `upload_dataset_file(upload, source)` streams a `Path` or open binary file to
+  the session's presigned URL without sending the SDK JWT or API key. Failed PUTs
+  and unreadable local files raise `QTSUploadError` without exposing the URL.
+
+### Changed
+
+- Public reads now use explicit names: `list_exchanges`, `list_instruments`,
+  `get_strategy`, `get_prepare_status`, `get_backtest_result`,
+  `get_sweep_result`, `get_sweep_sensitivity`, `get_sweep_run_equity_curve`,
+  `finalize_dataset_upload`, and `get_dataset_upload` replace their terse
+  predecessors.
+- The generated client dependency is pinned to `qtsurfer-api-client==0.111.2`.
+  A spent upload session now has the API's documented `409` finalization response;
+  open a new session instead of reusing that upload id.
+
+## [0.2.0] — 2026-08-27
+
+### Added
+
+- High-level workflow surface over `qtsurfer-api-client`, parity with the Java /
+  TypeScript SDKs (module `qtsurfer_sdk._workflows`):
+  - Strategy: `compile_strategy`, `validate_strategy`, `strategy_state`,
+    `list_strategies`, `delete_strategy`, `get_strategy_code`.
+  - Catalog: `exchanges`, `instruments` (with optional segment).
+  - Backtest: `prepare`, `prepare_status`, `execute`, `backtest_result`,
+    `cancel_backtest`.
+  - Sweep: `sweep`, `sweep_result`, `sweep_sensitivity`,
+    `sweep_run_equity_curve`, `cancel_sweep`.
+  - Dataset: `create_dataset`, `list_datasets`, `get_dataset`,
+    `delete_dataset`, `finalize_upload`, `dataset_upload`.
+- Error hierarchy parity: `QTSCompileError`, `QTSPreparationError`,
+  `QTSExecutionError`, `QTSTimeoutError`, `QTSCanceledError`, `QTSDownloadError`.
+- `backtest_result` returns a raw `httpx.Response` (not the generated
+  `sync` value), so poll loops can handle the `202`-running state without
+  the generated parser KeyError'ing on a partially-populated `results`
+  body (missing `strategyId` while running).
+
+### Changed
+
+- Workflows exposed as methods on `AuthenticatedSession`
+  (`session.exchanges()`, `session.prepare(...)`, `session.backtest_result(...)`,
+  ...) in addition to the `_workflows` module functions — parity with the
+  Java/TS SDK `AuthenticatedClient` surface.
+- README rewritten to document the full workflow surface with reproducible
+  examples.
+- Dependency pinned to `qtsurfer-api-client==0.110.3` (OpenAPI spec 0.110.3;
+  adds the Dataset feature and dataset-backed prepare/execute).
+- `import` fixed for the generated auth endpoint moved to
+  `qtsurfer.api.client._generated.api.auth.authenticate` in 0.110.3.
+
+### Fixed
+
+- `AuthenticatedSession` now imports the auth operation from its new module
+  path, restoring `auth()` against `qtsurfer-api-client` 0.110.x.
+
+## [0.1.0] — 2026-05-25
+
+### Added
+
+- Initial release. `auth(apikey)` helper exchanges a long-lived API key for a short-lived JWT in one call and returns an `AuthenticatedSession`.
+  - Reads `QTSURFER_APIKEY` from the environment when no apikey is passed.
+  - Caches the JWT in memory by default; adopters can plug in a custom `TokenStore` (file, secret manager, desktop keychain).
+  - `session.call(fn)` wraps any `qtsurfer-api-client` call with refresh-on-401: refresh once, retry once, surface the error otherwise.
+  - `session.client` exposes the underlying `qtsurfer-api-client` `AuthenticatedClient` for direct typed calls; its `token` attribute is mutated on refresh so in-flight references see the latest JWT.
+- `TokenStore` protocol (`load` / `save` / `clear`) with the default `InMemoryTokenStore`.
+- `QTSAuthError` (subclass of `QTSError`) for missing-apikey and JWT-exchange failures.
+- Depends on `qtsurfer-api-client >= 0.95.1` (provides the `auth` operation and `AuthTokenResponse` / `AuthTokenError` schemas).

qtsurfer_sdk-0.2.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_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.5
+Name: qtsurfer-sdk
+Version: 0.2.0
+Summary: Opinionated Python SDK for QTSurfer — auth helper with refresh, pluggable token storage, and high-level workflows (strategies, backtest, sweep, datasets) over qtsurfer-api-client.
+Project-URL: Homepage, https://github.com/QTSurfer/sdk-python
+Project-URL: Repository, https://github.com/QTSurfer/sdk-python
+Project-URL: Issues, https://github.com/QTSurfer/sdk-python/issues
+Project-URL: OpenAPI Spec, https://github.com/QTSurfer/qtsurfer-api
+Project-URL: API Client, https://github.com/QTSurfer/api-client-python
+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: auth,backtest,jwt,qtsurfer,sdk,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: httpx<1,>=0.23
+Requires-Dist: qtsurfer-api-client==0.111.2
+Description-Content-Type: text/markdown
+
+# qtsurfer-sdk
+
+<p align="center">
+  <a href="https://github.com/QTSurfer/sdk-python/actions/workflows/ci.yml"><img src="https://github.com/QTSurfer/sdk-python/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://pypi.org/project/qtsurfer-sdk/"><img src="https://img.shields.io/pypi/v/qtsurfer-sdk.svg" alt="PyPI"></a>
+  <img src="https://img.shields.io/pypi/pyversions/qtsurfer-sdk.svg" alt="Python versions">
+  <a href="https://qtsurfer.github.io/sdk-python/"><img src="https://img.shields.io/badge/docs-pdoc-blue" alt="pdoc"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a>
+</p>
+
+Opinionated Python SDK for [QTSurfer](https://qtsurfer.com), built on top of
+[`qtsurfer-api-client`](https://github.com/QTSurfer/api-client-python).
+
+Where `qtsurfer-api-client` gives you one function per API endpoint, this package
+adds **auth helpers**, **token refresh**, **pluggable token storage**, and
+**high-level workflows** (strategies, backtest, sweep, datasets) — go from an API
+key to a typed backtest in a few lines.
+
+> The strategy code itself stays on the JVM — QTSurfer's backtest engine is Java.
+> This SDK is for orchestration: minting tokens, calling endpoints, processing results.
+
+## Guides
+
+The hand-written guides mirror the SDK family structure.
+
+- [Authentication](docs/auth.md)
+- [Exchanges and instruments](docs/exchange.md)
+- [Strategies and validation](docs/strategy.md)
+- [Backtests and parameter sweeps](docs/backtesting.md)
+- [Dataset uploads](docs/datasets.md)
+- [API coverage](docs/api-coverage.md)
+
+## Installation
+
+```bash
+pip install qtsurfer-sdk
+# or, with uv:
+uv add qtsurfer-sdk
+```
+
+Requires Python 3.11+. The transitive [`qtsurfer-api-client`](https://github.com/QTSurfer/api-client-python)
+(auto-generated from the OpenAPI spec) comes along automatically.
+
+> **Import path**: this package imports as `qtsurfer_sdk` (sibling to the
+> auto-generated `qtsurfer.api.client.*` tree). Two top-level names keep the SDK
+> and the raw client cleanly separate.
+
+## Quick start
+
+```python
+from qtsurfer_sdk import auth
+
+# Reads QTSURFER_APIKEY from env when no argument is passed.
+session = auth()
+
+# Or point at a different API base (defaults to production):
+# session = auth("ak_...", base_url="https://api.qtsurfer.net/v1")
+
+exchanges = session.list_exchanges()
+for ex in exchanges:
+    print(ex.id, ex.name)
+```
+
+JWT refresh on 401 is handled for you (refresh once, retry once).
+
+## Workflows
+
+The SDK exposes a workflow surface mirroring `sdk-java` / `sdk-ts`. Every method
+is routed through the session (refresh-on-401) and returns the api-client's
+typed model objects.
+
+### Strategy
+
+```python
+src = '''public class EmaCross extends AbstractTickerStrategy { ... }'''
+
+comp = session.compile_strategy(src)       # CompileStrategyResponse200
+sid = comp.strategy_id
+
+session.validate_strategy(sid)             # 202/pending or already-recorded verdict
+state = session.get_strategy(sid)          # validation, notices, requiredSources
+session.list_strategies()                  # your registered strategies
+code = session.get_strategy_code(sid)      # read back the exact source
+session.delete_strategy(sid)               # release it
+```
+
+### Catalog
+
+```python
+session.list_exchanges()                              # [Exchange, ...]
+session.list_instruments("binance")                   # 1876 instruments
+session.list_instruments("binance", segment="spot")   # a specific segment
+```
+
+### Backtest
+
+```python
+# 1. prepare a data window -> a job id
+acc = session.prepare(
+    exchange_id="binance", type_="ticker",
+    instrument="BTC/USDT", from_="2026-08-18", to="2026-08-19",
+)
+pid = acc.job_id
+
+# 2. poll until Completed
+import time
+while True:
+    st = session.get_prepare_status(exchange_id="binance", type_="ticker", job_id=pid)
+    if st.status == "Completed":
+        break
+    time.sleep(3)
+
+# 3. execute a compiled strategy over the prepared window
+ex = session.execute(
+    exchange_id="binance", type_="ticker",
+    prepare_job_id=pid, strategy_id=sid,
+)
+jid = ex.job_id
+
+# 4. poll the raw result (202 while running; parse results only on 200)
+while True:
+    resp = session.get_backtest_result(exchange_id="binance", type_="ticker", job_id=jid)
+    if resp.status_code == 202:
+        time.sleep(3)
+        continue
+    resp.raise_for_status()
+    results = resp.json()["results"]  # pnl, totalTrades, sharpeRatio, equityCurve...
+    break
+```
+
+### Sweep
+
+```python
+accepted = session.sweep(
+    exchange_id="binance", type_="ticker",
+    request_id=pid,                     # the prepare job id
+    strategy_id=sid,
+    params={"cycle.seconds": {"values": [10, 20, 30]}},  # note: annotation name, not field
+    objective="sharpe",
+)
+swid = accepted.sweep_id
+
+res = session.get_sweep_result(exchange_id="binance", type_="ticker", request_id=pid, sweep_id=swid)
+for row in res.leaderboard:
+    print(row.rank, row.sharpe, row.params)
+
+session.get_sweep_sensitivity(exchange_id="binance", type_="ticker", request_id=pid, sweep_id=swid)
+session.get_sweep_run_equity_curve(..., run_ix=0) # a retained trial's curve
+session.cancel_sweep(...)
+```
+
+### Datasets (bring your own data)
+
+```python
+created = session.create_dataset(name="My BTC ticks", instrument="BTC/USDT")
+# created.dataset_id, created.upload_id, created.upload.url (presigned R2 URL)
+# PUT your CSV to created.upload.url (no auth header needed), then:
+session.finalize_dataset_upload(dataset_id=created.dataset_id, upload_id=created.upload_id)
+# poll:
+state = session.get_dataset_upload(dataset_id=created.dataset_id, upload_id=created.upload_id)
+# state.status == "ready" -> backtest against it with exchange_id="user":
+acc = session.prepare(
+    exchange_id="user", type_="ticker", dataset_id=created.dataset_id,
+    dataset_version_id=state.version.id, from_=..., to=...,
+)
+
+session.list_datasets()
+session.get_dataset(dataset_id)
+session.delete_dataset(dataset_id)
+```
+
+To upload the file itself, pass the creation result or an upload session together
+with a `pathlib.Path` (or an open binary file) to `upload_dataset_file`. The PUT
+goes directly to the presigned URL without the session JWT or API key. A successful
+PUT only stores the bytes; call `finalize_dataset_upload` to queue ingest.
+
+```python
+from pathlib import Path
+
+session.upload_dataset_file(created, Path("BTC_USDT.csv"))
+session.finalize_dataset_upload(dataset_id=created.dataset_id, upload_id=created.upload_id)
+
+# Add a subsequent version after the earlier upload has finalized:
+next_upload = session.open_dataset_upload(created.dataset_id)
+session.upload_dataset_file(next_upload, Path("BTC_USDT_corrected.csv"))
+```
+
+`open_dataset_upload` is safe to retry while an upload is open: it returns the
+same session. Once an upload has produced a version, its `upload_id` is spent;
+`finalize_dataset_upload` returns `409` and a new session is required.
+
+### Raw client access
+
+Every workflow goes through the session's underlying generated
+`AuthenticatedClient`. To call an endpoint the workflows don't wrap, or to
+inspect a raw `Response`:
+
+```python
+from qtsurfer.api.client._generated.api.exchange import get_exchanges
+
+session.call(lambda c: get_exchanges.sync(client=c))          # plain
+resp = session.call(lambda c: get_exchanges.sync_detailed(client=c))  # raw Response
+```
+
+## Environment
+
+| Variable          | Purpose                                              |
+| ----------------- | ---------------------------------------------------- |
+| `QTSURFER_APIKEY` | API key consumed by `auth()` when no arg is passed   |
+
+## Pluggable token storage
+
+Tokens are kept in memory by default. Implement `TokenStore` (a `Protocol`) to
+back them by file, secret manager, or keychain:
+
+```python
+import json
+from pathlib import Path
+from qtsurfer.api.client._generated.models import AuthTokenResponse
+from qtsurfer_sdk import TokenStore, auth
+
+class FileStore(TokenStore):
+    def __init__(self, path: Path): self.path = path
+    def load(self) -> AuthTokenResponse | None:
+        return AuthTokenResponse.from_dict(json.loads(self.path.read_text())) if self.path.exists() else None
+    def save(self, token: AuthTokenResponse) -> None: self.path.write_text(json.dumps(token.to_dict()))
+    def clear(self) -> None: self.path.unlink(missing_ok=True)
+
+session = auth(store=FileStore(Path.home() / ".qtsurfer" / "token.json"))
+```
+
+## Error hierarchy
+
+```python
+from qtsurfer_sdk import QTSError, QTSAuthError, QTSPreparationError, QTSExecutionError
+```
+
+* `QTSError` — base for all SDK errors (carries optional `.status`).
+* `QTSAuthError` — missing/invalid apikey, or non-2xx from `POST /auth/token`.
+* `QTSCompileError` — `POST /strategy` could not compile/register.
+* `QTSPreparationError` — a `prepare` stage failed.
+* `QTSExecutionError` — a backtest/sweep execution failed.
+* `QTSTimeoutError`, `QTSCanceledError`, `QTSDownloadError` — reserved (poll deadline, cancel, downloads).
+
+## Roadmap
+
+* **v0.1 — auth helper** ✅
+* **v0.2 — high-level workflows** ✅ (strategies, catalog, backtest, sweep, datasets)
+* **v0.3 — async overload** mirroring `*_asyncio` api-client variants
+* **v0.4 — domain handles** (`Strategy`, `Backtest`) with progress callbacks
+
+## License
+
+Apache-2.0 — see [LICENSE](./LICENSE).