qdash-client 0.1.0__tar.gz

qdash_client-0.1.0/.env.example

@@ -0,0 +1,24 @@
+# Required
+QDASH_BASE_URL=https://example.qdash/api
+
+# Recommended authentication mode
+QDASH_API_TOKEN=
+
+# Optional headers
+QDASH_PROJECT_ID=
+QDASH_CF_ACCESS_CLIENT_ID=
+QDASH_CF_ACCESS_CLIENT_SECRET=
+
+# Optional request settings
+QDASH_TIMEOUT_SECONDS=30
+QDASH_RETRY_MAX_ATTEMPTS=3
+QDASH_RETRY_BACKOFF_SECONDS=0.2
+QDASH_RETRY_MAX_BACKOFF_SECONDS=5.0
+QDASH_VERIFY_TLS=true
+QDASH_PROXY=
+QDASH_USER_AGENT=
+
+# Optional legacy username/password authentication mode
+QDASH_USERNAME=
+QDASH_PASSWORD_ENV=QDASH_PASSWORD
+QDASH_PASSWORD=

qdash_client-0.1.0/.gitignore

@@ -0,0 +1,246 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,react
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,react
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+# lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+*.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### react ###
+.DS_*
+logs
+**/*.backup.*
+**/*.back.*
+
+node_modules
+bower_components
+
+*.sublime*
+
+psd
+thumb
+sketch
+
+# End of https://www.toptal.com/developers/gitignore/api/python,react
+
+.env
+compose.override.yaml
+
+# Databases
+*.db
+memo_store.toml
+prefect.db-shm
+prefect.db-wal
+.next
+next-env.d.ts
+# tailwind.config.js
+postgres_data/*
+!postgres_data/.gitkeep
+mongo_data/*
+!mongo_data/.gitkeep
+!mongo_data/data/
+mongo_data/data/*
+!mongo_data/data/.gitkeep
+!mongo_data/data/db/
+mongo_data/data/db/*
+!mongo_data/data/db/.gitkeep
+calib_data/*
+!calib_data/.gitkeep
+src/qdash/workflow/user_flows/*/
+*.env
+docker_node_modules/
+.venv/src/
+log/
+.pnpm-store/
+qpu_data/
+docs/.vitepress/cache/
+ui/.vite/
+ui/tsconfig.tsbuildinfo
+src/qdash/workflow/images/*
+src/qdash/workflow/.system_note.json
+src/qdash/workflow/*.json
+src/qdash/workflow/.calibration/*.json
+src/qdash/workflow/.classifier/*/*
+# Ignore all files in config directory except committed configs
+config/qubex/*
+!config/qubex/qubex.example/
+config/qubex-config/*
+config/task-knowledge/
+src/tools/schedule/*
+.serena/
+.mcp.json
+.tmp/*
+/.claude/settings.local.json
+docs/internal/*
+docs/papers/*
+config/qubex-config
+scripts/estimate_qubit_frequency
+scripts/estimate-resonator-frequency
+.direnv

qdash_client-0.1.0/PKG-INFO

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: qdash-client
+Version: 0.1.0
+Summary: Python client for the QDash API
+Author-email: OQTOPUS Team <oqtopus-team@googlegroups.com>
+Requires-Python: <3.13,>=3.11
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.8.0
+Description-Content-Type: text/markdown
+
+# qdash.client README
+
+`qdash.client` is a Python client for calling the QDash API.
+
+- `services`: domain logic such as authentication, retries, and response normalization
+- `rest`: low-level HTTP communication
+
+This package follows the same approach as `oqtopus-client`, separating the transport layer from the service layer.
+For user-facing examples, see `docs/user-guide/qdash-client.md`.
+
+## Installation
+
+Install the lightweight client package when only programmatic API access is needed.
+
+```bash
+pip install qdash-client
+```
+
+For development against this repository:
+
+```bash
+pip install ./src/qdash/client
+```
+
+The distribution name is `qdash-client`, but the Python import path is `qdash.client`.
+
+## Publishing
+
+`qdash-client` is published from this repository with PyPI Trusted Publishing. Configure the
+`qdash-client` project on PyPI to trust this GitHub repository and the
+`.github/workflows/publish-qdash-client.yml` workflow.
+
+Release tags use the `qdash-client-v<version>` format and must match the version in
+`pyproject.toml`.
+
+```bash
+git tag qdash-client-v0.1.0
+git push origin qdash-client-v0.1.0
+```
+
+## Minimal Quick Start
+
+This is a minimal example using `/chips`, `/metrics/config`, and `/task-results/timeseries`.
+
+```python
+from qdash.client import QDashClient
+
+client = QDashClient()
+try:
+    chips = client.list_chips()
+    print(chips.total)
+    print([chip.chip_id for chip in chips.chips])
+
+    metrics_config = client.get_metrics_config()
+    print(metrics_config.keys())
+
+    series = client.get_task_results_timeseries(
+        chip_id="chip-001",
+        parameter="t1",
+        start_at="2026-06-01T00:00:00Z",
+        end_at="2026-06-02T00:00:00Z",
+    )
+    print(series.data)
+finally:
+    client.close()
+```
+
+## 1. Public API
+
+In most cases, you will use the following:
+
+- `QDashClient`
+- `QDashConfig`
+- Exception classes such as `QDashApiError`
+
+```python
+from qdash.client import QDashClient, QDashConfig
+```
+
+## 2. Configuration
+
+### 2.1 From Environment Variables
+
+```python
+from qdash.client import QDashConfig, QDashClient
+
+config = QDashConfig.from_env()
+client = QDashClient(config)
+```
+
+Main environment variables:
+
+- `QDASH_BASE_URL`
+- `QDASH_API_TOKEN`
+- `QDASH_PROJECT_ID`
+- `QDASH_CF_ACCESS_CLIENT_ID`
+- `QDASH_CF_ACCESS_CLIENT_SECRET`
+- `QDASH_TIMEOUT_SECONDS`
+- `QDASH_RETRY_MAX_ATTEMPTS`
+- `QDASH_RETRY_BACKOFF_SECONDS`
+- `QDASH_RETRY_MAX_BACKOFF_SECONDS`
+- `QDASH_VERIFY_TLS`
+- `QDASH_PROXY`
+- `QDASH_USER_AGENT`
+
+For legacy username/password authentication, set:
+
+- `QDASH_USERNAME`
+- `QDASH_PASSWORD_ENV`
+- the environment variable named by `QDASH_PASSWORD_ENV` (defaults to `QDASH_PASSWORD`)
+
+### 2.2 From a Configuration File
+
+```python
+from qdash.client import QDashConfig, QDashClient
+
+config = QDashConfig.from_file(section="default")
+client = QDashClient(config)
+```
+
+If `path` is omitted:
+
+1. If `XDG_CONFIG_HOME` is set: `$XDG_CONFIG_HOME/qdash/config.ini`
+2. Otherwise: `~/.config/qdash/config.ini`
+
+Example configuration:
+
+```ini
+[default]
+base_url = https://example.qdash/api
+api_token = your-token
+project_id = your-project-id
+cf_access_client_id = your-cf-client-id
+cf_access_client_secret = your-cf-client-secret
+timeout_seconds = 30
+retry_max_attempts = 3
+retry_backoff_seconds = 0.2
+retry_max_backoff_seconds = 5.0
+```
+
+For legacy username/password authentication from a config file, use `username` and `password_env`
+instead of `api_token`.
+
+### 2.3 Automatic Loading
+
+```python
+from qdash.client import QDashClient
+
+# Loads config.ini by default
+client = QDashClient()
+```
+
+## 3. Usage (Synchronous API)
+
+### 3.1 List Chips
+
+```python
+from qdash.client import QDashClient
+
+client = QDashClient()
+try:
+    chips = client.list_chips()
+    print([chip.chip_id for chip in chips.chips])
+finally:
+    client.close()
+```
+
+### 3.2 Time-Series Metrics
+
+```python
+from qdash.client import QDashClient
+
+client = QDashClient()
+try:
+    series = client.get_task_results_timeseries(
+        chip_id="chip-001",
+        parameter="t1",
+        tag="calibration",
+        start_at="2026-06-01T00:00:00Z",
+        end_at="2026-06-08T00:00:00Z",
+        qid="Q00",
+    )
+    print(series.data)
+finally:
+    client.close()
+```
+
+### 3.3 Metrics Configuration
+
+```python
+from qdash.client import QDashClient
+
+client = QDashClient()
+try:
+    config = client.get_metrics_config()
+    print(config.get("qubit_metrics", {}).keys())
+    print(config.get("coupling_metrics", {}).keys())
+finally:
+    client.close()
+```
+
+## 4. Usage (Asynchronous API)
+
+```python
+import asyncio
+from qdash.client import QDashClient
+
+async def main() -> None:
+    client = QDashClient()
+    try:
+        chips = await client.list_chips_async()
+        print([chip.chip_id for chip in chips.chips])
+
+        metrics_config = await client.get_metrics_config_async()
+        print(metrics_config.get("qubit_metrics", {}).keys())
+
+        series = await client.get_task_results_timeseries_async(
+            chip_id="chip-001",
+            parameter="t1",
+            start_at="2026-06-01T00:00:00Z",
+            end_at="2026-06-02T00:00:00Z",
+        )
+        print(series.data)
+    finally:
+        client.close()
+
+asyncio.run(main())
+```
+
+## 5. Error Handling
+
+Main exceptions:
+
+- `QDashApiError` (base class)
+- `QDashAuthError` (missing or invalid authentication)
+- `QDashNotFoundError` (404)
+- `QDashValidationError` (422)
+- `QDashTransportError` (transport errors, timeouts, or other HTTP statuses)
+
+```python
+from qdash.client import QDashClient, QDashApiError
+
+client = QDashClient()
+try:
+    print(client.list_chips().chips)
+except QDashApiError as exc:
+    print(exc.status_code, exc)
+finally:
+    client.close()
+```
+
+## 6. Exporter Helper Functionality
+
+`QDashClient` provides helper methods for exporters.
+
+- `normalize_chip_metrics(chip_id, payload)`
+
+This method converts a QDash API response into a list of
+`NormalizedMetricRecord` objects that are easier for exporters to consume.
+
+## 7. Using the Low-Level REST Client Directly
+
+In most cases, using `QDashClient` is recommended.
+
+If you need direct access to the low-level API, you can use `qdash.client.rest`.
+
+```python
+from qdash.client.rest import ApiClient, Configuration
+
+cfg = Configuration(host="https://example.qdash/api")
+rest_client = ApiClient(cfg)
+
+try:
+    resp = rest_client.request("GET", "/chips")
+    print(resp.status_code, resp.data)
+finally:
+    rest_client.close()
+```