Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,30 @@ jobs:
- name: Run lints
run: ./scripts/lint

upload:
if: github.repository == 'stainless-sdks/kernel-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
Expand Down
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.1.0-alpha.9"
".": "0.1.0-alpha.10"
}
8 changes: 4 additions & 4 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 4
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-07d481d1498bf9677437b555e9ec2d843d50107faa7501e4c430a32b1f3c3343.yml
openapi_spec_hash: 296f78d82afbac95fad12c5eabd71f18
config_hash: 2c8351ba6611ce4a352e248405783846
configured_endpoints: 5
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-f40e779e2a48f5e37361f2f4a9879e5c40f2851b8033c23db69ec7b91242bf69.yml
openapi_spec_hash: 2dfa146149e61363f1ec40bf9251eb7c
config_hash: 2ddaa85513b6670889b1a56c905423c7
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Changelog

## 0.1.0-alpha.10 (2025-05-19)

Full Changelog: [v0.1.0-alpha.9...v0.1.0-alpha.10](https://github.com/onkernel/kernel-python-sdk/compare/v0.1.0-alpha.9...v0.1.0-alpha.10)

### Features

* **api:** update via SDK Studio ([a382570](https://github.com/onkernel/kernel-python-sdk/commit/a382570e96f3bae625cb176e746038fcdf0e8e73))


### Chores

* **ci:** fix installation instructions ([c897375](https://github.com/onkernel/kernel-python-sdk/commit/c8973750a1ae58f7c8eee588bbe874862dbbb46d))
* **ci:** upload sdks to package manager ([03d0f7f](https://github.com/onkernel/kernel-python-sdk/commit/03d0f7f19be9614f5a81bd5c31117febd68ec5e9))
* **internal:** codegen related update ([49143bd](https://github.com/onkernel/kernel-python-sdk/commit/49143bdcb6635ae79b1c4c5fddc9017d8d81b4d7))

## 0.1.0-alpha.9 (2025-05-14)

Full Changelog: [v0.1.0-alpha.8...v0.1.0-alpha.9](https://github.com/onkernel/kernel-python-sdk/compare/v0.1.0-alpha.8...v0.1.0-alpha.9)
Expand Down
54 changes: 22 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ client = Kernel(
environment="development",
)

response = client.apps.deploy(
entrypoint_rel_path="app.py",
deployment = client.apps.deployments.create(
entrypoint_rel_path="main.ts",
file=b"REPLACE_ME",
version="REPLACE_ME",
version="1.0.0",
)
print(response.apps)
print(deployment.apps)
```

While you can provide an `api_key` keyword argument,
Expand All @@ -63,12 +63,12 @@ client = AsyncKernel(


async def main() -> None:
response = await client.apps.deploy(
entrypoint_rel_path="app.py",
deployment = await client.apps.deployments.create(
entrypoint_rel_path="main.ts",
file=b"REPLACE_ME",
version="REPLACE_ME",
version="1.0.0",
)
print(response.apps)
print(deployment.apps)


asyncio.run(main())
Expand All @@ -95,8 +95,8 @@ from kernel import Kernel

client = Kernel()

client.apps.deploy(
entrypoint_rel_path="app.py",
client.apps.deployments.create(
entrypoint_rel_path="src/app.py",
file=Path("/path/to/file"),
)
```
Expand All @@ -119,10 +119,8 @@ from kernel import Kernel
client = Kernel()

try:
client.apps.deploy(
entrypoint_rel_path="app.py",
file=b"REPLACE_ME",
version="REPLACE_ME",
client.browsers.create(
invocation_id="REPLACE_ME",
)
except kernel.APIConnectionError as e:
print("The server could not be reached")
Expand Down Expand Up @@ -166,10 +164,8 @@ client = Kernel(
)

# Or, configure per-request:
client.with_options(max_retries=5).apps.deploy(
entrypoint_rel_path="app.py",
file=b"REPLACE_ME",
version="REPLACE_ME",
client.with_options(max_retries=5).browsers.create(
invocation_id="REPLACE_ME",
)
```

Expand All @@ -193,10 +189,8 @@ client = Kernel(
)

# Override per-request:
client.with_options(timeout=5.0).apps.deploy(
entrypoint_rel_path="app.py",
file=b"REPLACE_ME",
version="REPLACE_ME",
client.with_options(timeout=5.0).browsers.create(
invocation_id="REPLACE_ME",
)
```

Expand Down Expand Up @@ -238,15 +232,13 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
from kernel import Kernel

client = Kernel()
response = client.apps.with_raw_response.deploy(
entrypoint_rel_path="app.py",
file=b"REPLACE_ME",
version="REPLACE_ME",
response = client.browsers.with_raw_response.create(
invocation_id="REPLACE_ME",
)
print(response.headers.get('X-My-Header'))

app = response.parse() # get the object that `apps.deploy()` would have returned
print(app.apps)
browser = response.parse() # get the object that `browsers.create()` would have returned
print(browser.session_id)
```

These methods return an [`APIResponse`](https://github.com/onkernel/kernel-python-sdk/tree/main/src/kernel/_response.py) object.
Expand All @@ -260,10 +252,8 @@ The above interface eagerly reads the full response body when you make the reque
To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.

```python
with client.apps.with_streaming_response.deploy(
entrypoint_rel_path="app.py",
file=b"REPLACE_ME",
version="REPLACE_ME",
with client.browsers.with_streaming_response.create(
invocation_id="REPLACE_ME",
) as response:
print(response.headers.get("X-My-Header"))

Expand Down
28 changes: 21 additions & 7 deletions api.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,39 @@
# Apps

## Deployments

Types:

```python
from kernel.types.apps import DeploymentCreateResponse
```

Methods:

- <code title="post /deploy">client.apps.deployments.<a href="./src/kernel/resources/apps/deployments.py">create</a>(\*\*<a href="src/kernel/types/apps/deployment_create_params.py">params</a>) -> <a href="./src/kernel/types/apps/deployment_create_response.py">DeploymentCreateResponse</a></code>

## Invocations

Types:

```python
from kernel.types import AppDeployResponse, AppInvokeResponse, AppRetrieveInvocationResponse
from kernel.types.apps import InvocationCreateResponse, InvocationRetrieveResponse
```

Methods:

- <code title="post /apps/deploy">client.apps.<a href="./src/kernel/resources/apps.py">deploy</a>(\*\*<a href="src/kernel/types/app_deploy_params.py">params</a>) -> <a href="./src/kernel/types/app_deploy_response.py">AppDeployResponse</a></code>
- <code title="post /apps/invoke">client.apps.<a href="./src/kernel/resources/apps.py">invoke</a>(\*\*<a href="src/kernel/types/app_invoke_params.py">params</a>) -> <a href="./src/kernel/types/app_invoke_response.py">AppInvokeResponse</a></code>
- <code title="get /apps/invocations/{id}">client.apps.<a href="./src/kernel/resources/apps.py">retrieve_invocation</a>(id) -> <a href="./src/kernel/types/app_retrieve_invocation_response.py">AppRetrieveInvocationResponse</a></code>
- <code title="post /invocations">client.apps.invocations.<a href="./src/kernel/resources/apps/invocations.py">create</a>(\*\*<a href="src/kernel/types/apps/invocation_create_params.py">params</a>) -> <a href="./src/kernel/types/apps/invocation_create_response.py">InvocationCreateResponse</a></code>
- <code title="get /invocations/{id}">client.apps.invocations.<a href="./src/kernel/resources/apps/invocations.py">retrieve</a>(id) -> <a href="./src/kernel/types/apps/invocation_retrieve_response.py">InvocationRetrieveResponse</a></code>

# Browser
# Browsers

Types:

```python
from kernel.types import BrowserCreateSessionResponse
from kernel.types import BrowserCreateResponse, BrowserRetrieveResponse
```

Methods:

- <code title="post /browser">client.browser.<a href="./src/kernel/resources/browser.py">create_session</a>(\*\*<a href="src/kernel/types/browser_create_session_params.py">params</a>) -> <a href="./src/kernel/types/browser_create_session_response.py">BrowserCreateSessionResponse</a></code>
- <code title="post /browsers">client.browsers.<a href="./src/kernel/resources/browsers.py">create</a>(\*\*<a href="src/kernel/types/browser_create_params.py">params</a>) -> <a href="./src/kernel/types/browser_create_response.py">BrowserCreateResponse</a></code>
- <code title="get /browsers/{id}">client.browsers.<a href="./src/kernel/resources/browsers.py">retrieve</a>(id) -> <a href="./src/kernel/types/browser_retrieve_response.py">BrowserRetrieveResponse</a></code>
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "kernel"
version = "0.1.0-alpha.9"
version = "0.1.0-alpha.10"
description = "The official Python library for the kernel API"
dynamic = ["readme"]
license = "Apache-2.0"
Expand Down
25 changes: 25 additions & 0 deletions scripts/utils/upload-artifact.sh
Original file line number Diff line number Diff line change
@@ -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 --pre 'https://pkg.stainless.com/s/kernel-python/$SHA'\033[0m"
else
echo -e "\033[31mFailed to upload artifact.\033[0m"
exit 1
fi
19 changes: 10 additions & 9 deletions src/kernel/_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@
)
from ._utils import is_given, get_async_library
from ._version import __version__
from .resources import apps, browser
from .resources import browsers
from ._streaming import Stream as Stream, AsyncStream as AsyncStream
from ._exceptions import KernelError, APIStatusError
from ._base_client import (
DEFAULT_MAX_RETRIES,
SyncAPIClient,
AsyncAPIClient,
)
from .resources.apps import apps

__all__ = [
"ENVIRONMENTS",
Expand All @@ -50,7 +51,7 @@

class Kernel(SyncAPIClient):
apps: apps.AppsResource
browser: browser.BrowserResource
browsers: browsers.BrowsersResource
with_raw_response: KernelWithRawResponse
with_streaming_response: KernelWithStreamedResponse

Expand Down Expand Up @@ -133,7 +134,7 @@ def __init__(
)

self.apps = apps.AppsResource(self)
self.browser = browser.BrowserResource(self)
self.browsers = browsers.BrowsersResource(self)
self.with_raw_response = KernelWithRawResponse(self)
self.with_streaming_response = KernelWithStreamedResponse(self)

Expand Down Expand Up @@ -246,7 +247,7 @@ def _make_status_error(

class AsyncKernel(AsyncAPIClient):
apps: apps.AsyncAppsResource
browser: browser.AsyncBrowserResource
browsers: browsers.AsyncBrowsersResource
with_raw_response: AsyncKernelWithRawResponse
with_streaming_response: AsyncKernelWithStreamedResponse

Expand Down Expand Up @@ -329,7 +330,7 @@ def __init__(
)

self.apps = apps.AsyncAppsResource(self)
self.browser = browser.AsyncBrowserResource(self)
self.browsers = browsers.AsyncBrowsersResource(self)
self.with_raw_response = AsyncKernelWithRawResponse(self)
self.with_streaming_response = AsyncKernelWithStreamedResponse(self)

Expand Down Expand Up @@ -443,25 +444,25 @@ def _make_status_error(
class KernelWithRawResponse:
def __init__(self, client: Kernel) -> None:
self.apps = apps.AppsResourceWithRawResponse(client.apps)
self.browser = browser.BrowserResourceWithRawResponse(client.browser)
self.browsers = browsers.BrowsersResourceWithRawResponse(client.browsers)


class AsyncKernelWithRawResponse:
def __init__(self, client: AsyncKernel) -> None:
self.apps = apps.AsyncAppsResourceWithRawResponse(client.apps)
self.browser = browser.AsyncBrowserResourceWithRawResponse(client.browser)
self.browsers = browsers.AsyncBrowsersResourceWithRawResponse(client.browsers)


class KernelWithStreamedResponse:
def __init__(self, client: Kernel) -> None:
self.apps = apps.AppsResourceWithStreamingResponse(client.apps)
self.browser = browser.BrowserResourceWithStreamingResponse(client.browser)
self.browsers = browsers.BrowsersResourceWithStreamingResponse(client.browsers)


class AsyncKernelWithStreamedResponse:
def __init__(self, client: AsyncKernel) -> None:
self.apps = apps.AsyncAppsResourceWithStreamingResponse(client.apps)
self.browser = browser.AsyncBrowserResourceWithStreamingResponse(client.browser)
self.browsers = browsers.AsyncBrowsersResourceWithStreamingResponse(client.browsers)


Client = Kernel
Expand Down
2 changes: 1 addition & 1 deletion src/kernel/_version.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

__title__ = "kernel"
__version__ = "0.1.0-alpha.9" # x-release-please-version
__version__ = "0.1.0-alpha.10" # x-release-please-version
26 changes: 13 additions & 13 deletions src/kernel/resources/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
AppsResourceWithStreamingResponse,
AsyncAppsResourceWithStreamingResponse,
)
from .browser import (
BrowserResource,
AsyncBrowserResource,
BrowserResourceWithRawResponse,
AsyncBrowserResourceWithRawResponse,
BrowserResourceWithStreamingResponse,
AsyncBrowserResourceWithStreamingResponse,
from .browsers import (
BrowsersResource,
AsyncBrowsersResource,
BrowsersResourceWithRawResponse,
AsyncBrowsersResourceWithRawResponse,
BrowsersResourceWithStreamingResponse,
AsyncBrowsersResourceWithStreamingResponse,
)

__all__ = [
Expand All @@ -24,10 +24,10 @@
"AsyncAppsResourceWithRawResponse",
"AppsResourceWithStreamingResponse",
"AsyncAppsResourceWithStreamingResponse",
"BrowserResource",
"AsyncBrowserResource",
"BrowserResourceWithRawResponse",
"AsyncBrowserResourceWithRawResponse",
"BrowserResourceWithStreamingResponse",
"AsyncBrowserResourceWithStreamingResponse",
"BrowsersResource",
"AsyncBrowsersResource",
"BrowsersResourceWithRawResponse",
"AsyncBrowsersResourceWithRawResponse",
"BrowsersResourceWithStreamingResponse",
"AsyncBrowsersResourceWithStreamingResponse",
]
Loading