cyborgdb 0.11.0__tar.gz

cyborgdb-0.11.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,94 @@
+name: Bug Report
+description: Fill this form out to report a bug in `cyborgdb_py`.
+title: "[BUG]: "
+labels: bug
+projects: cyborginc/4
+type: Bug
+assignees: []
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Bug Report Checklist
+      options:
+        - label: I have searched for similar issues in the repository.
+          required: true
+        - label: I have included all relevant information for reproducing the bug.
+          required: true
+
+  - type: input
+    attributes:
+      label: Summary
+      placeholder: "Enter a short description of the issue..."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Detailed Description
+      placeholder: "Explain the issue in detail..."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: Provide step-by-step instructions for reproducing the issue.
+      placeholder: |
+        Example:
+        1. Initialize the `cyborgdb_py` service using Python 3.10.
+        2. Call the `POST /vector` API with the following payload.
+        3. ...
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Observed Behavior
+      description: Describe what actually happened when the issue occurred.
+      placeholder: "What did you observe? Include error messages, unexpected responses, etc."
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: Describe what you expected to happen instead.
+      placeholder: "What should the service have done?"
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: API Version
+      description: Specify the version of `cyborgdb_py`.
+      placeholder: "e.g., v0.9.0"
+    
+  - type: dropdown
+    attributes:
+      label: Operating System
+      description: "Select the operating system you're using."
+      options:
+        - Not OS-specific
+        - Windows
+        - macOS
+        - Linux
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Severity
+      description: Indicate the impact of this bug.
+      options:
+        - Critical - Breaks functionality or crashes the service.
+        - Major - Significant issue but a workaround exists.
+        - Minor - Low impact, minor functionality affected.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: Provide logs, error messages, or any other supporting details.
+      placeholder: "Paste logs, stack traces, or screenshots here."

cyborgdb-0.11.0/.github/ISSUE_TEMPLATE/epic.yml

@@ -0,0 +1,68 @@
+name: New Epic
+description: Use this form to create new epics or user stories.
+title: "[EPIC]: "
+projects: cyborginc/4
+type: Feature
+assignees: []
+
+body:
+  - type: textarea
+    attributes:
+      label: Background
+      placeholder: |
+        Provide a concise but informative overview of the task. Include any relevant business or technical context, such as:
+        - Problem Statement: What issue or opportunity prompted this task?
+        - Current State: What is happening now, and why is it insufficient?
+        - Desired Outcome: What do we hope to achieve by completing this task?
+        - Stakeholders: Who cares about this and why?
+        
+        This section should help anyone new to the task quickly understand the “why” behind it and how it fits into the bigger picture.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: User Story
+      placeholder: |
+        Use clear, human-centered language. The user story should represent a real-world need or problem, focusing on the user's perspective. Avoid technical jargon unless the user persona is technical.
+          *Format: As [a specific user role or persona], I want [to perform a specific action or experience], so that [I can achieve a specific outcome or benefit].*
+        
+        *Example: As a first-time customer, I want to save my shopping cart without creating an account so that I can return later and complete my purchase.*
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Acceptance Criteria
+      placeholder: |
+        List the specific, testable conditions that must be met for this task to be considered complete. These should clearly define **DONE** and help guide both development and QA efforts.
+        - Include:
+          - Expected behavior under normal conditions
+          - Handling of edge cases or exceptions
+          - UI/UX considerations (if applicable)
+          - Security, performance, or accessibility requirements (if relevant)
+        - Each item should be independently verifiable
+        
+        - *Example: Password Reset Flow*
+          - *User can request a password reset via email*
+          - *Email contains a secure, time-limited reset link (expires after 1 hour)*
+          - *User is redirected to a reset form upon clicking the link*
+          - *Password must meet complexity rules (min 8 chars, 1 number, 1 special character)*
+          - *Error message shown if link is expired or invalid*
+          - *Confirmation message shown after successful reset*
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional Notes
+      placeholder: |
+        Use this section to capture any important supporting information that does not fit neatly elsewhere, such as:
+        - Related Links: JIRA tickets, PRDs, Figma mockups, Notion docs, API specs, etc.
+        - Dependencies: Is this blocked by another task? Is it part of a feature set?
+        - Technical Notes: Known constraints, decisions made, code references, or areas of complexity.
+        - Business Constraints:** Legal, compliance, timeline pressures, or customer commitments.
+
+        This section is useful for cross-functional collaborators and future maintainers who may need additional context or history.
+    validations:
+      required: false

cyborgdb-0.11.0/.github/ISSUE_TEMPLATE/task.yml

@@ -0,0 +1,56 @@
+name: New Issue/Task
+description: Use this form to create new issues or tasks.
+projects: cyborginc/4
+type: Task
+assignees: []
+
+body:
+  - type: textarea
+    attributes:
+      label: Background
+      placeholder: |
+        Provide a concise but informative overview of the task. Include any relevant business or technical context, such as:
+        - Problem Statement: What issue or opportunity prompted this task?
+        - Current State: What is happening now, and why is it insufficient?
+        - Desired Outcome: What do we hope to achieve by completing this task?
+        - Stakeholders: Who cares about this and why?
+        
+        This section should help anyone new to the task quickly understand the “why” behind it and how it fits into the bigger picture.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Acceptance Criteria
+      placeholder: |
+        List the specific, testable conditions that must be met for this task to be considered complete. These should clearly define **DONE** and help guide both development and QA efforts.
+        - Include:
+          - Expected behavior under normal conditions
+          - Handling of edge cases or exceptions
+          - UI/UX considerations (if applicable)
+          - Security, performance, or accessibility requirements (if relevant)
+        - Each item should be independently verifiable
+        
+        - *Example: Password Reset Flow*
+          - *User can request a password reset via email*
+          - *Email contains a secure, time-limited reset link (expires after 1 hour)*
+          - *User is redirected to a reset form upon clicking the link*
+          - *Password must meet complexity rules (min 8 chars, 1 number, 1 special character)*
+          - *Error message shown if link is expired or invalid*
+          - *Confirmation message shown after successful reset*
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional Notes
+      placeholder: |
+        Use this section to capture any important supporting information that does not fit neatly elsewhere, such as:
+        - Related Links: JIRA tickets, PRDs, Figma mockups, Notion docs, API specs, etc.
+        - Dependencies: Is this blocked by another task? Is it part of a feature set?
+        - Technical Notes: Known constraints, decisions made, code references, or areas of complexity.
+        - Business Constraints:** Legal, compliance, timeline pressures, or customer commitments.
+
+        This section is useful for cross-functional collaborators and future maintainers who may need additional context or history.
+    validations:
+      required: false

cyborgdb-0.11.0/.github/workflows/build_and_package_wheels.yml

@@ -0,0 +1,89 @@
+name: Builda and Package Wheels
+
+on:
+  push:
+    branches: ["main"]
+    tags:
+      - "v*"
+
+jobs:
+  build_distributions:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+
+      - name: Set Version from Tag for Wheels
+        if: github.ref_type == 'tag'
+        shell: bash
+        run: |
+          VERSION=${GITHUB_REF_NAME#v}
+          echo "Setting exact version $VERSION for tag build"
+          echo "SETUPTOOLS_SCM_PRETEND_VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build wheel
+
+      - name: Build distributions
+        run: |
+          python -m build --sdist --wheel --outdir dist/
+          echo "Built distributions:"
+          ls -la dist/
+
+      - name: Store distributions as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: cyborgdb-dist
+          path: dist/*
+          retention-days: 5
+  
+  publish_to_pypi:
+    needs: [build_distributions]
+    runs-on: ubuntu-latest
+    if: github.ref_type == 'tag'
+    environment:
+      name: prod
+    permissions:
+      id-token: write
+      contents: write
+    
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: cyborgdb-dist
+          path: dist
+          
+      - name: Display structure of downloaded files
+        run: ls -la dist/
+          
+      - name: Create release archive
+        run: |
+          VERSION=${GITHUB_REF_NAME#v}  # Strip the 'v' prefix if present
+          echo "Creating archive for version $VERSION"
+          zip -r cyborgdb-${VERSION}-dist.zip dist/
+          echo "RELEASE_VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Publish to GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            cyborgdb-${{ env.RELEASE_VERSION }}-dist.zip
+          generate_release_notes: true
+          draft: false
+          tag_name: ${{ github.ref_name }}
+          
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          skip-existing: true

cyborgdb-0.11.0/.gitignore

@@ -0,0 +1,72 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# 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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+venv/
+.venv/
+.python-version
+.pytest_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints
+
+datasets
+
+.DS_Store
+
+venv

cyborgdb-0.11.0/.openapi-generator/FILES

@@ -0,0 +1,97 @@
+cyborgdb/openapi_client/__init__.py
+cyborgdb/openapi_client/api/__init__.py
+cyborgdb/openapi_client/api/default_api.py
+cyborgdb/openapi_client/api_client.py
+cyborgdb/openapi_client/api_response.py
+cyborgdb/openapi_client/configuration.py
+cyborgdb/openapi_client/docs/BatchQueryRequest.md
+cyborgdb/openapi_client/docs/Contents.md
+cyborgdb/openapi_client/docs/CreateIndexRequest.md
+cyborgdb/openapi_client/docs/CyborgdbServiceApiSchemasIndexSuccessResponseModel.md
+cyborgdb/openapi_client/docs/CyborgdbServiceApiSchemasVectorsSuccessResponseModel.md
+cyborgdb/openapi_client/docs/DefaultApi.md
+cyborgdb/openapi_client/docs/DeleteRequest.md
+cyborgdb/openapi_client/docs/ErrorResponseModel.md
+cyborgdb/openapi_client/docs/GetRequest.md
+cyborgdb/openapi_client/docs/GetResponseModel.md
+cyborgdb/openapi_client/docs/GetResultItemModel.md
+cyborgdb/openapi_client/docs/HTTPValidationError.md
+cyborgdb/openapi_client/docs/IndexConfig.md
+cyborgdb/openapi_client/docs/IndexIVFFlatModel.md
+cyborgdb/openapi_client/docs/IndexIVFModel.md
+cyborgdb/openapi_client/docs/IndexIVFPQModel.md
+cyborgdb/openapi_client/docs/IndexInfoResponseModel.md
+cyborgdb/openapi_client/docs/IndexListResponseModel.md
+cyborgdb/openapi_client/docs/IndexOperationRequest.md
+cyborgdb/openapi_client/docs/QueryRequest.md
+cyborgdb/openapi_client/docs/QueryResponse.md
+cyborgdb/openapi_client/docs/QueryResultItem.md
+cyborgdb/openapi_client/docs/Request.md
+cyborgdb/openapi_client/docs/Results.md
+cyborgdb/openapi_client/docs/TrainRequest.md
+cyborgdb/openapi_client/docs/UpsertRequest.md
+cyborgdb/openapi_client/docs/ValidationError.md
+cyborgdb/openapi_client/docs/ValidationErrorLocInner.md
+cyborgdb/openapi_client/docs/VectorItem.md
+cyborgdb/openapi_client/exceptions.py
+cyborgdb/openapi_client/models/__init__.py
+cyborgdb/openapi_client/models/batch_query_request.py
+cyborgdb/openapi_client/models/contents.py
+cyborgdb/openapi_client/models/create_index_request.py
+cyborgdb/openapi_client/models/cyborgdb_service_api_schemas_index_success_response_model.py
+cyborgdb/openapi_client/models/cyborgdb_service_api_schemas_vectors_success_response_model.py
+cyborgdb/openapi_client/models/delete_request.py
+cyborgdb/openapi_client/models/error_response_model.py
+cyborgdb/openapi_client/models/get_request.py
+cyborgdb/openapi_client/models/get_response_model.py
+cyborgdb/openapi_client/models/get_result_item_model.py
+cyborgdb/openapi_client/models/http_validation_error.py
+cyborgdb/openapi_client/models/index_config.py
+cyborgdb/openapi_client/models/index_info_response_model.py
+cyborgdb/openapi_client/models/index_ivf_flat_model.py
+cyborgdb/openapi_client/models/index_ivf_model.py
+cyborgdb/openapi_client/models/index_ivfpq_model.py
+cyborgdb/openapi_client/models/index_list_response_model.py
+cyborgdb/openapi_client/models/index_operation_request.py
+cyborgdb/openapi_client/models/query_request.py
+cyborgdb/openapi_client/models/query_response.py
+cyborgdb/openapi_client/models/query_result_item.py
+cyborgdb/openapi_client/models/request.py
+cyborgdb/openapi_client/models/results.py
+cyborgdb/openapi_client/models/train_request.py
+cyborgdb/openapi_client/models/upsert_request.py
+cyborgdb/openapi_client/models/validation_error.py
+cyborgdb/openapi_client/models/validation_error_loc_inner.py
+cyborgdb/openapi_client/models/vector_item.py
+cyborgdb/openapi_client/rest.py
+cyborgdb/openapi_client/test/__init__.py
+cyborgdb/openapi_client/test/test_batch_query_request.py
+cyborgdb/openapi_client/test/test_contents.py
+cyborgdb/openapi_client/test/test_create_index_request.py
+cyborgdb/openapi_client/test/test_cyborgdb_service_api_schemas_index_success_response_model.py
+cyborgdb/openapi_client/test/test_cyborgdb_service_api_schemas_vectors_success_response_model.py
+cyborgdb/openapi_client/test/test_default_api.py
+cyborgdb/openapi_client/test/test_delete_request.py
+cyborgdb/openapi_client/test/test_error_response_model.py
+cyborgdb/openapi_client/test/test_get_request.py
+cyborgdb/openapi_client/test/test_get_response_model.py
+cyborgdb/openapi_client/test/test_get_result_item_model.py
+cyborgdb/openapi_client/test/test_http_validation_error.py
+cyborgdb/openapi_client/test/test_index_config.py
+cyborgdb/openapi_client/test/test_index_info_response_model.py
+cyborgdb/openapi_client/test/test_index_ivf_flat_model.py
+cyborgdb/openapi_client/test/test_index_ivf_model.py
+cyborgdb/openapi_client/test/test_index_ivfpq_model.py
+cyborgdb/openapi_client/test/test_index_list_response_model.py
+cyborgdb/openapi_client/test/test_index_operation_request.py
+cyborgdb/openapi_client/test/test_query_request.py
+cyborgdb/openapi_client/test/test_query_response.py
+cyborgdb/openapi_client/test/test_query_result_item.py
+cyborgdb/openapi_client/test/test_request.py
+cyborgdb/openapi_client/test/test_results.py
+cyborgdb/openapi_client/test/test_train_request.py
+cyborgdb/openapi_client/test/test_upsert_request.py
+cyborgdb/openapi_client/test/test_validation_error.py
+cyborgdb/openapi_client/test/test_validation_error_loc_inner.py
+cyborgdb/openapi_client/test/test_vector_item.py
+cyborgdb/openapi_client_README.md

cyborgdb-0.11.0/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.13.0

cyborgdb-0.11.0/.openapi-generator-ignore

@@ -0,0 +1,27 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+
+# Ignore all files in the client folder
+cyborgdb/client/**
+cyborgdb/__init__.py

cyborgdb-0.11.0/CODEOWNERS

@@ -0,0 +1,8 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @global-owner1 and @global-owner2 will be requested for
+# review when someone opens a pull request.
+*       @dupontcyborg @ahellegit

cyborgdb-0.11.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025, Cyborg Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

cyborgdb-0.11.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: cyborgdb
+Version: 0.11.0
+Summary: CyborgDB Python Client
+Author: Cyborg Inc.
+License: MIT
+Project-URL: Homepage, https://www.cyborg.co
+Project-URL: Documentation, https://docs.cyborg.co
+Keywords: OpenAPI,OpenAPI-Generator,CyborgDB Service
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: C++
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: license-file
+
+# CyborgDB Python SDK
+
+The **CyborgDB Python SDK** provides a comprehensive client library for interacting with [CyborgDB](https://www.cyborg.co), the first Confidential Vector Database. This SDK enables you to perform encrypted vector operations including ingestion, search, and retrieval while maintaining end-to-end encryption of your vector embeddings.
+
+This SDK provides an interface to `cyborgdb-service` which you will need to separately install and run in order to use the SDK. For more info, please see our [docs](https://docs.cyborg.co)
+
+**Why CyborgDB?**
+
+Vector Search powers critical AI applications like RAG systems, recommendation engines, and semantic search. The CyborgDB JS/TS SDK brings confidential computing to your web applications and Node.js services, ensuring vector embeddings remain encrypted throughout their entire lifecycle while providing fast, accurate search capabilities.
+
+**Key Features**
+
+* **End-to-End Encryption**: All vector operations maintain encryption with client-side keys
+* **Batch Operations**: Efficient batch queries and upserts for high-throughput applications
+* **Flexible Indexing**: Support for multiple index types (IVFFlat, IVFPQ, etc.) with customizable parameters
+
+**Installation**
+
+1. Install `cyborgdb-service`
+
+```bash
+# Install the CyborgDB Service
+pip install cyborgdb-service
+```
+
+2. Install `cyborgdb` SDK:
+
+```bash
+# Install the CyborgDB Python SDK
+pip install cyborgdb
+```
+
+**Usage**
+
+```py
+# TBD
+```
+
+**Advanced Usage**
+
+**Batch Queries**
+
+```py
+# TBD
+```
+
+**Metadata Filtering**
+
+```py
+# TBD
+```
+
+**Index Training**
+
+```py
+# TBD
+```
+
+**Documentation**
+
+For more detailed documentation, visit:
+* [CyborgDB Documentation](https://docs.cyborg.co/)
+
+**License**
+
+The CyborgDB Python SDK is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+**About CyborgDB**
+
+CyborgDB is dedicated to making AI safe and secure through confidential computing. We develop solutions that enable organizations to leverage AI while maintaining the confidentiality and privacy of their data.
+
+[Visit our website](https://www.cyborg.co/) | [Contact Us](mailto:hello@cyborg.co)