Merge pull request #90 from hyperspell/release-please--branches--main--changes--next

release: 0.15.0

Author: maebert

.github/workflows/ci.yml

@@ -30,6 +30,30 @@ jobs:
       - name: Run lints
         run: ./scripts/lint
 
+  upload:
+    if: github.repository == 'stainless-sdks/hyperspell-python'
+    timeout-minutes: 10
+    name: upload
+    permissions:
+      contents: read
+      id-token: write
+    runs-on: depot-ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get GitHub OIDC Token
+        id: github-oidc
+        uses: actions/github-script@v6
+        with:
+          script: core.setOutput('github_token', await core.getIDToken());
+
+      - name: Upload tarball
+        env:
+          URL: https://pkg.stainless.com/s
+          AUTH: ${{ steps.github-oidc.outputs.github_token }}
+          SHA: ${{ github.sha }}
+        run: ./scripts/utils/upload-artifact.sh
+
   test:
     timeout-minutes: 10
     name: test

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.12.0"
+  ".": "0.13.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 14
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-099cd79547bb459ecbd2442e4f93fc17f4f9a2dead413f06a0b39afb6541db07.yml
-openapi_spec_hash: 81afcb8056acd1af983d70f817911738
-config_hash: 85255d5a167e2f4bcf8a9314d653ec01
+configured_endpoints: 10
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-287b83fd66b657b044f4ab280ab0e72a2ed72c0da50e4a7d09ce98123982262f.yml
+openapi_spec_hash: fcef51b5cf5e602a2d8025546e27e24a
+config_hash: a39dfe90372d06d735dfb3d27b30409f

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.13.0 (2025-05-26)
+
+Full Changelog: [v0.12.0...v0.13.0](https://github.com/hyperspell/python-sdk/compare/v0.12.0...v0.13.0)
+
+### Features
+
+* **api:** api update ([74e46e9](https://github.com/hyperspell/python-sdk/commit/74e46e9fc6e453ec408fc2641f8e3526df13927e))
+* **api:** api update ([bccb2cc](https://github.com/hyperspell/python-sdk/commit/bccb2cc8cac69ba61476aa224a753b5c88f14eca))
+* **api:** api update ([c05d86e](https://github.com/hyperspell/python-sdk/commit/c05d86eac76104c1a6b312663dd6b973070b51ce))
+* **api:** api update ([b20e5b5](https://github.com/hyperspell/python-sdk/commit/b20e5b5bf8b894faf515d9ca770d757078d265d9))
+* **api:** update via SDK Studio ([5512870](https://github.com/hyperspell/python-sdk/commit/55128707104ac90ebcefe72795161d98c1790e6c))
+
+
+### Bug Fixes
+
+* **package:** support direct resource imports ([d8b54e0](https://github.com/hyperspell/python-sdk/commit/d8b54e020764be85d1fd2de167deb1e825e6aceb))
+
+
+### Chores
+
+* **ci:** fix installation instructions ([3567715](https://github.com/hyperspell/python-sdk/commit/3567715ff2540fa63cc0feed569a98d42af731a6))
+* **ci:** upload sdks to package manager ([733ed75](https://github.com/hyperspell/python-sdk/commit/733ed759b06612d5da69c9fd241240c951ef1964))
+* **docs:** grammar improvements ([5e2a523](https://github.com/hyperspell/python-sdk/commit/5e2a523d1c080c7254e9b2f0e3bc112c0bbfbe09))
+* **internal:** avoid errors for isinstance checks on proxies ([c86a164](https://github.com/hyperspell/python-sdk/commit/c86a164ba1bdecfc7db3c4d12c9753d8c99ec232))
+
 ## 0.12.0 (2025-04-30)
 
 Full Changelog: [v0.11.0...v0.12.0](https://github.com/hyperspell/python-sdk/compare/v0.11.0...v0.12.0)

README.md

@@ -28,7 +28,7 @@ import os
 from hyperspell import Hyperspell
 
 client = Hyperspell(
-    api_key=os.environ.get("HYPERSPELL_API_KEY"),  # This is the default and can be omitted
+    api_key=os.environ.get("HYPERSPELL_TOKEN"),  # This is the default and can be omitted
 )
 
 document_status = client.documents.add(
@@ -39,7 +39,7 @@ print(document_status.id)
 
 While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `HYPERSPELL_API_KEY="My API Key"` to your `.env` file
+to add `HYPERSPELL_TOKEN="My API Key"` to your `.env` file
 so that your API Key is not stored in source control.
 
 ## Async usage
@@ -52,7 +52,7 @@ import asyncio
 from hyperspell import AsyncHyperspell
 
 client = AsyncHyperspell(
-    api_key=os.environ.get("HYPERSPELL_API_KEY"),  # This is the default and can be omitted
+    api_key=os.environ.get("HYPERSPELL_TOKEN"),  # This is the default and can be omitted
 )
 
 
@@ -143,7 +143,7 @@ first_page = await client.documents.list(
 
 print(f"next page cursor: {first_page.next_cursor}")  # => "next page cursor: ..."
 for document in first_page.items:
-    print(document.id)
+    print(document.resource_id)
 
 # Remove `await` for non-async usage.
 ```
@@ -165,8 +165,9 @@ response = client.query.search(
         "after": datetime.fromisoformat("2019-12-27T18:11:19.117"),
         "before": datetime.fromisoformat("2019-12-27T18:11:19.117"),
         "box": {},
-        "collections": {"collections": ["string"]},
+        "collections": {},
         "google_calendar": {"calendar_id": "calendar_id"},
+        "google_drive": {},
         "notion": {"notion_page_ids": ["string"]},
         "reddit": {
             "period": "hour",
@@ -194,7 +195,6 @@ from hyperspell import Hyperspell
 client = Hyperspell()
 
 client.documents.upload(
-    collection="collection",
     file=Path("/path/to/file"),
 )
 ```

SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Hyperspell please follow the respective company's security reporting guidelines.
+or products provided by Hyperspell, please follow the respective company's security reporting guidelines.
 
 ### Hyperspell Terms and Policies
 
-Please contact hello@hyperspell.com for any questions or concerns regarding security of our services.
+Please contact hello@hyperspell.com for any questions or concerns regarding the security of our services.
 
 ---
 

api.md

@@ -39,30 +39,26 @@ Methods:
 Types:
 
 ```python
-from hyperspell.types import Document, DocumentStatus, DocumentListResponse, DocumentGetResponse
+from hyperspell.types import DocumentStatus, DocumentListResponse
 ```
 
 Methods:
 
 - <code title="get /documents/list">client.documents.<a href="./src/hyperspell/resources/documents.py">list</a>(\*\*<a href="src/hyperspell/types/document_list_params.py">params</a>) -> <a href="./src/hyperspell/types/document_list_response.py">SyncCursorPage[DocumentListResponse]</a></code>
 - <code title="post /documents/add">client.documents.<a href="./src/hyperspell/resources/documents.py">add</a>(\*\*<a href="src/hyperspell/types/document_add_params.py">params</a>) -> <a href="./src/hyperspell/types/document_status.py">DocumentStatus</a></code>
-- <code title="post /documents/scrape">client.documents.<a href="./src/hyperspell/resources/documents.py">add_url</a>(\*\*<a href="src/hyperspell/types/document_add_url_params.py">params</a>) -> <a href="./src/hyperspell/types/document_status.py">DocumentStatus</a></code>
-- <code title="get /documents/get/{document_id}">client.documents.<a href="./src/hyperspell/resources/documents.py">get</a>(document_id) -> <a href="./src/hyperspell/types/document_get_response.py">object</a></code>
 - <code title="post /documents/upload">client.documents.<a href="./src/hyperspell/resources/documents.py">upload</a>(\*\*<a href="src/hyperspell/types/document_upload_params.py">params</a>) -> <a href="./src/hyperspell/types/document_status.py">DocumentStatus</a></code>
 
 # Collections
 
 Types:
 
 ```python
-from hyperspell.types import Collection, CollectionListResponse
+from hyperspell.types import CollectionListResponse
 ```
 
 Methods:
 
-- <code title="post /collections/add">client.collections.<a href="./src/hyperspell/resources/collections.py">create</a>(\*\*<a href="src/hyperspell/types/collection_create_params.py">params</a>) -> <a href="./src/hyperspell/types/collection.py">Collection</a></code>
 - <code title="get /collections/list">client.collections.<a href="./src/hyperspell/resources/collections.py">list</a>(\*\*<a href="src/hyperspell/types/collection_list_params.py">params</a>) -> <a href="./src/hyperspell/types/collection_list_response.py">SyncCursorPage[CollectionListResponse]</a></code>
-- <code title="get /collections/get/{name}">client.collections.<a href="./src/hyperspell/resources/collections.py">get</a>(name) -> <a href="./src/hyperspell/types/collection.py">Collection</a></code>
 
 # Query
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hyperspell"
-version = "0.12.0"
+version = "0.13.0"
 description = "The official Python library for the hyperspell API"
 dynamic = ["readme"]
 license = "Apache-2.0"

scripts/utils/upload-artifact.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+set -exuo pipefail
+
+RESPONSE=$(curl -X POST "$URL" \
+  -H "Authorization: Bearer $AUTH" \
+  -H "Content-Type: application/json")
+
+SIGNED_URL=$(echo "$RESPONSE" | jq -r '.url')
+
+if [[ "$SIGNED_URL" == "null" ]]; then
+  echo -e "\033[31mFailed to get signed URL.\033[0m"
+  exit 1
+fi
+
+UPLOAD_RESPONSE=$(tar -cz . | curl -v -X PUT \
+  -H "Content-Type: application/gzip" \
+  --data-binary @- "$SIGNED_URL" 2>&1)
+
+if echo "$UPLOAD_RESPONSE" | grep -q "HTTP/[0-9.]* 200"; then
+  echo -e "\033[32mUploaded build to Stainless storage.\033[0m"
+  echo -e "\033[32mInstallation: pip install 'https://pkg.stainless.com/s/hyperspell-python/$SHA'\033[0m"
+else
+  echo -e "\033[31mFailed to upload artifact.\033[0m"
+  exit 1
+fi

src/hyperspell/__init__.py

@@ -1,5 +1,7 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+import typing as _t
+
 from . import types
 from ._types import NOT_GIVEN, Omit, NoneType, NotGiven, Transport, ProxiesTypes
 from ._utils import file_from_path
@@ -78,6 +80,9 @@
     "DefaultAsyncHttpxClient",
 ]
 
+if not _t.TYPE_CHECKING:
+    from ._utils._resources_proxy import resources as resources
+
 _setup_logging()
 
 # Update the __module__ attribute for exported symbols so that