vqflow 0.1.0__tar.gz

vqflow-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 reasonable and customary use in 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 Additional Liability. 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 additional liability.
+
+   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 [yyyy] [name of copyright owner]
+
+   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.

vqflow-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md LICENSE pyproject.toml MANIFEST.in
+recursive-include vqflow *.py py.typed
+prune tests
+global-exclude __pycache__ *.py[cod] .env .env.* *.pem *.key *.p12 *.pfx

vqflow-0.1.0/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: vqflow
+Version: 0.1.0
+Summary: Download and generate versioned VQFlow dataset exports from Python.
+Author: VQFlow Labs
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/vqflowlabs/vqflow-python-packages
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# vqflow
+
+Download versioned VQFlow dataset exports from Python. When an export version
+does not exist, the SDK requests it, waits for generation and downloads its ZIP.
+Both the resource interface and fluent builder use the same export workflow.
+
+Requires Python 3.10 or newer. Install the released package from PyPI with:
+
+```sh
+python -m pip install vqflow
+```
+
+For development, install from an authorized repository checkout:
+
+```sh
+python -m pip install ./packages/vqflow
+```
+
+## Connect
+
+Provide your API key and HTTPS API base URL at runtime. The base URL must include
+the API prefix, such as `/api/v1`. The SDK reads only `VQFLOW_API_KEY` and
+`VQFLOW_API_URL` when the corresponding constructor arguments are omitted; it
+does not load environment files or machine credential stores.
+
+```python
+import os
+from vqflow import VQFlow
+
+vqf = VQFlow(
+    api_key=os.environ["VQFLOW_API_KEY"],
+    base_url=os.environ["VQFLOW_API_URL"],
+)
+```
+
+Use an API key with access to the selected dataset. Downloading an existing
+export can use a read-only key. Generating a missing version requires a key
+permitted to create exports. The SDK respects the account's existing permissions.
+
+## Resource interface
+
+```python
+dataset = (
+    vqf.workspace("sample-workspace")
+    .project("sample-project")
+    .dataset("sample-dataset")
+)
+
+dataset_export_path = dataset.export("coco", "training-v1", "./datasets")
+```
+
+Use exact workspace, project and dataset names rather than display titles.
+Selection is lazy: navigation methods do not issue requests until an export runs.
+`dataset_export_path` is a `pathlib.Path` to the downloaded ZIP, named
+`vqflow-export-<export-id>.zip` inside the destination directory. Archives remain
+zipped. Existing local files are not overwritten unless `overwrite=True`.
+
+The second `export()` argument is always the **dataset export version**. If
+multiple datasets share a name, select the source dataset explicitly:
+
+```python
+dataset = (
+    vqf.workspace("sample-workspace")
+    .project("sample-project")
+    .dataset("sample-dataset", dataset_version="source-v2")
+)
+```
+
+Omitting `dataset_version` requires an unambiguous dataset. Explicit `None`
+selects the unversioned dataset. The SDK never silently selects the latest match.
+
+Supported formats are `coco`, `category_folders`, and `vqflow_native`. You can
+also use the `ExportFormat` enum. ZIP is the result container for all formats.
+
+## Export builder
+
+```python
+from vqflow import DatasetExportBuilder
+
+builder = (
+    DatasetExportBuilder(vqf)
+    .withWorkspace("sample-workspace")
+    .withProject("sample-project")
+    .withDataset("sample-dataset")
+    .withFormat("coco")
+    .withVersion("training-v1")
+    .withDestination("./datasets")
+)
+
+dataset_export_path = builder.export()
+```
+
+The `with...` methods configure the builder. Only `export()` and
+`exportCurated()` perform requests. Use `withDatasetVersion(...)` when the source
+dataset needs disambiguation; `withVersion(...)` always names the export version.
+
+## Media selection
+
+Exports include all media in the selected dataset unless status filters are
+specified. Review and QA filters combine with **AND**:
+
+```python
+from vqflow import ReviewStatus, QAStatus
+
+dataset_export_path = (
+    builder
+    .withVersion("approved-v1")
+    .withReview(ReviewStatus.APPROVED)
+    .withQA(QAStatus.APPROVED)
+    .export()
+)
+```
+
+The curated shortcut requires both review and QA to be approved:
+
+```python
+dataset_export_path = builder.withVersion("curated-v1").exportCurated()
+```
+
+`exportCurated()` overrides both filters for that call and leaves the builder's
+saved filters unchanged. Each filter supports `APPROVED`, `REJECTED`, `PENDING`,
+and `NONE`, as an enum or case-insensitive string. Python `None` removes the
+filter; the string `"NONE"` selects media whose actual status is `NONE`.
+
+The resource interface accepts the same filters:
+
+```python
+dataset_export_path = dataset.export(
+    "coco", "approved-v1", "./datasets", review="APPROVED", qa="APPROVED"
+)
+```
+
+## Code supplied by VQFlow
+
+The portal's generated code supplies the API address and the exact dataset and
+export identities. An exact export ID preserves the stored export's original
+media selection, including selections beyond the SDK's review/QA filters:
+
+```python
+# Keep your API key private. Do not share it or commit it to source control.
+dataset_export_path = dataset.export(
+    "coco", "training-v1", "./datasets", export_id=44
+)
+```
+
+The builder equivalent is `.withExportId(44).export()`. An explicit ID never
+creates a replacement if that export is missing, and it cannot be combined with
+review/QA overrides or `exportCurated()`. Use a new export version without an
+explicit ID when requesting a different selection.
+
+With an explicit export ID, the workspace, project, dataset name and optional
+dataset version are checked against the export's saved snapshot. Current
+workspace and dataset lists are not consulted, so the code remains usable after
+the source dataset moves or its version changes, provided the account still has
+access to the stored export. Without an export ID, navigation selects the current
+dataset as usual.
+
+Generated code containing an API key is private to you. Do not share the snippet,
+include it in a public notebook, or commit it to source control. Revoke a key in
+VQFlow if it has been exposed.
+
+## Existing versions and generation
+
+The SDK searches all result pages for the exact dataset and export version. It
+selects the requested format and ZIP result, then verifies the saved task's
+selection. Other formats may coexist under the same export-version label.
+
+- A ready matching export is downloaded using a fresh access URL.
+- A matching queued or running export is awaited and reused.
+- An absent export version starts one normal background export.
+- A version with incompatible format or filters raises an export conflict.
+- Duplicate matching exports and same-name datasets raise an ambiguity error.
+- Legacy exports without verifiable selection metadata require a new export
+  version. They are not assumed to contain all media.
+- A failed or cancelled export raises an error. It is not treated as missing.
+
+Choose a new export version when changing the selection. Existing versions are
+reused without rebuilding them from the dataset's current contents. An empty
+selection is reported through the normal server export failure.
+
+## Waiting, failures and retries
+
+```python
+dataset_export_path = dataset.export(
+    "coco", "training-v1", "./datasets",
+    wait_timeout=7200,
+    poll_interval=5,
+)
+```
+
+The default wait limit is two hours. A timeout does not cancel server work;
+`ExportTimeoutError` retains the task/export identifiers. Calling export again
+with the same version reuses that task. Scheduled server retries remain active
+work even when a previous attempt has an error.
+
+The SDK never automatically repeats an export-creation POST after an uncertain
+network outcome. `ExportCreationUncertainError` asks the caller to check the
+export version before trying again. The current API does not provide an atomic
+get-or-create operation: concurrent clients can create duplicate version
+records. The SDK detects observed duplicates and does not silently choose one.
+
+Typed errors are exported from `vqflow`, including `AuthenticationError`,
+`PermissionDeniedError`, `NotFoundError`, `AmbiguousResourceError`,
+`ExportConflictError`, `ExportFailedError`, `ExportTimeoutError`,
+`ExportCreationUncertainError`, `TransportError`, `ProtocolError`, and
+`DownloadError`. Errors omit raw server responses and credential-bearing URLs.
+
+Call `vqf.close()` when finished, or use `with VQFlow(...) as vqf:`.
+
+## Credential and download handling
+
+API keys are supplied only to the configured API. ZIP downloads use a separate
+unauthenticated connection. HTTPS is required; redirects and ambient proxy
+configuration are disabled. Archive data streams to a temporary file and is
+published at the final path only after a successful download and validation.
+
+Never put real keys, passwords, confidential data or captured API responses in
+source, examples, tests or package artifacts. Supply credentials only at runtime.
+
+## License
+
+Licensed under Apache-2.0. The complete license is included in the distribution.

vqflow-0.1.0/README.md

@@ -0,0 +1,222 @@
+# vqflow
+
+Download versioned VQFlow dataset exports from Python. When an export version
+does not exist, the SDK requests it, waits for generation and downloads its ZIP.
+Both the resource interface and fluent builder use the same export workflow.
+
+Requires Python 3.10 or newer. Install the released package from PyPI with:
+
+```sh
+python -m pip install vqflow
+```
+
+For development, install from an authorized repository checkout:
+
+```sh
+python -m pip install ./packages/vqflow
+```
+
+## Connect
+
+Provide your API key and HTTPS API base URL at runtime. The base URL must include
+the API prefix, such as `/api/v1`. The SDK reads only `VQFLOW_API_KEY` and
+`VQFLOW_API_URL` when the corresponding constructor arguments are omitted; it
+does not load environment files or machine credential stores.
+
+```python
+import os
+from vqflow import VQFlow
+
+vqf = VQFlow(
+    api_key=os.environ["VQFLOW_API_KEY"],
+    base_url=os.environ["VQFLOW_API_URL"],
+)
+```
+
+Use an API key with access to the selected dataset. Downloading an existing
+export can use a read-only key. Generating a missing version requires a key
+permitted to create exports. The SDK respects the account's existing permissions.
+
+## Resource interface
+
+```python
+dataset = (
+    vqf.workspace("sample-workspace")
+    .project("sample-project")
+    .dataset("sample-dataset")
+)
+
+dataset_export_path = dataset.export("coco", "training-v1", "./datasets")
+```
+
+Use exact workspace, project and dataset names rather than display titles.
+Selection is lazy: navigation methods do not issue requests until an export runs.
+`dataset_export_path` is a `pathlib.Path` to the downloaded ZIP, named
+`vqflow-export-<export-id>.zip` inside the destination directory. Archives remain
+zipped. Existing local files are not overwritten unless `overwrite=True`.
+
+The second `export()` argument is always the **dataset export version**. If
+multiple datasets share a name, select the source dataset explicitly:
+
+```python
+dataset = (
+    vqf.workspace("sample-workspace")
+    .project("sample-project")
+    .dataset("sample-dataset", dataset_version="source-v2")
+)
+```
+
+Omitting `dataset_version` requires an unambiguous dataset. Explicit `None`
+selects the unversioned dataset. The SDK never silently selects the latest match.
+
+Supported formats are `coco`, `category_folders`, and `vqflow_native`. You can
+also use the `ExportFormat` enum. ZIP is the result container for all formats.
+
+## Export builder
+
+```python
+from vqflow import DatasetExportBuilder
+
+builder = (
+    DatasetExportBuilder(vqf)
+    .withWorkspace("sample-workspace")
+    .withProject("sample-project")
+    .withDataset("sample-dataset")
+    .withFormat("coco")
+    .withVersion("training-v1")
+    .withDestination("./datasets")
+)
+
+dataset_export_path = builder.export()
+```
+
+The `with...` methods configure the builder. Only `export()` and
+`exportCurated()` perform requests. Use `withDatasetVersion(...)` when the source
+dataset needs disambiguation; `withVersion(...)` always names the export version.
+
+## Media selection
+
+Exports include all media in the selected dataset unless status filters are
+specified. Review and QA filters combine with **AND**:
+
+```python
+from vqflow import ReviewStatus, QAStatus
+
+dataset_export_path = (
+    builder
+    .withVersion("approved-v1")
+    .withReview(ReviewStatus.APPROVED)
+    .withQA(QAStatus.APPROVED)
+    .export()
+)
+```
+
+The curated shortcut requires both review and QA to be approved:
+
+```python
+dataset_export_path = builder.withVersion("curated-v1").exportCurated()
+```
+
+`exportCurated()` overrides both filters for that call and leaves the builder's
+saved filters unchanged. Each filter supports `APPROVED`, `REJECTED`, `PENDING`,
+and `NONE`, as an enum or case-insensitive string. Python `None` removes the
+filter; the string `"NONE"` selects media whose actual status is `NONE`.
+
+The resource interface accepts the same filters:
+
+```python
+dataset_export_path = dataset.export(
+    "coco", "approved-v1", "./datasets", review="APPROVED", qa="APPROVED"
+)
+```
+
+## Code supplied by VQFlow
+
+The portal's generated code supplies the API address and the exact dataset and
+export identities. An exact export ID preserves the stored export's original
+media selection, including selections beyond the SDK's review/QA filters:
+
+```python
+# Keep your API key private. Do not share it or commit it to source control.
+dataset_export_path = dataset.export(
+    "coco", "training-v1", "./datasets", export_id=44
+)
+```
+
+The builder equivalent is `.withExportId(44).export()`. An explicit ID never
+creates a replacement if that export is missing, and it cannot be combined with
+review/QA overrides or `exportCurated()`. Use a new export version without an
+explicit ID when requesting a different selection.
+
+With an explicit export ID, the workspace, project, dataset name and optional
+dataset version are checked against the export's saved snapshot. Current
+workspace and dataset lists are not consulted, so the code remains usable after
+the source dataset moves or its version changes, provided the account still has
+access to the stored export. Without an export ID, navigation selects the current
+dataset as usual.
+
+Generated code containing an API key is private to you. Do not share the snippet,
+include it in a public notebook, or commit it to source control. Revoke a key in
+VQFlow if it has been exposed.
+
+## Existing versions and generation
+
+The SDK searches all result pages for the exact dataset and export version. It
+selects the requested format and ZIP result, then verifies the saved task's
+selection. Other formats may coexist under the same export-version label.
+
+- A ready matching export is downloaded using a fresh access URL.
+- A matching queued or running export is awaited and reused.
+- An absent export version starts one normal background export.
+- A version with incompatible format or filters raises an export conflict.
+- Duplicate matching exports and same-name datasets raise an ambiguity error.
+- Legacy exports without verifiable selection metadata require a new export
+  version. They are not assumed to contain all media.
+- A failed or cancelled export raises an error. It is not treated as missing.
+
+Choose a new export version when changing the selection. Existing versions are
+reused without rebuilding them from the dataset's current contents. An empty
+selection is reported through the normal server export failure.
+
+## Waiting, failures and retries
+
+```python
+dataset_export_path = dataset.export(
+    "coco", "training-v1", "./datasets",
+    wait_timeout=7200,
+    poll_interval=5,
+)
+```
+
+The default wait limit is two hours. A timeout does not cancel server work;
+`ExportTimeoutError` retains the task/export identifiers. Calling export again
+with the same version reuses that task. Scheduled server retries remain active
+work even when a previous attempt has an error.
+
+The SDK never automatically repeats an export-creation POST after an uncertain
+network outcome. `ExportCreationUncertainError` asks the caller to check the
+export version before trying again. The current API does not provide an atomic
+get-or-create operation: concurrent clients can create duplicate version
+records. The SDK detects observed duplicates and does not silently choose one.
+
+Typed errors are exported from `vqflow`, including `AuthenticationError`,
+`PermissionDeniedError`, `NotFoundError`, `AmbiguousResourceError`,
+`ExportConflictError`, `ExportFailedError`, `ExportTimeoutError`,
+`ExportCreationUncertainError`, `TransportError`, `ProtocolError`, and
+`DownloadError`. Errors omit raw server responses and credential-bearing URLs.
+
+Call `vqf.close()` when finished, or use `with VQFlow(...) as vqf:`.
+
+## Credential and download handling
+
+API keys are supplied only to the configured API. ZIP downloads use a separate
+unauthenticated connection. HTTPS is required; redirects and ambient proxy
+configuration are disabled. Archive data streams to a temporary file and is
+published at the final path only after a successful download and validation.
+
+Never put real keys, passwords, confidential data or captured API responses in
+source, examples, tests or package artifacts. Supply credentials only at runtime.
+
+## License
+
+Licensed under Apache-2.0. The complete license is included in the distribution.