Skip to content
Draft
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body:

Describe who encountered the bug, the problem it creates, why it matters, and the observable criteria for a fix. Please check the latest `openshell` release on PyPI and search existing issues for possible duplicates before filing.

Problems with the gateway, CLI, or sandboxes belong in [NVIDIA/OpenShell](https://github.com/NVIDIA/OpenShell/issues). Do not report security vulnerabilities here; follow [SECURITY.md](https://github.com/ai-openshell/sdk-python/blob/main/SECURITY.md) instead.
Problems with the gateway, CLI, or sandboxes belong in [ai-openshell/openshell](https://github.com/ai-openshell/openshell/issues). Do not report security vulnerabilities here; follow [SECURITY.md](https://github.com/ai-openshell/sdk-python/blob/main/SECURITY.md) instead.

- type: textarea
id: user-story
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
blank_issues_enabled: false
contact_links:
- name: Gateway, CLI, or sandbox problem?
url: https://github.com/NVIDIA/OpenShell/issues/new/choose
url: https://github.com/ai-openshell/openshell/issues/new/choose
about: >
This repository is the Python SDK only. Report problems with the
OpenShell gateway, CLI, sandboxes, or the gRPC API in NVIDIA/OpenShell.
OpenShell gateway, CLI, sandboxes, or the gRPC API in ai-openshell/openshell.
- name: Security vulnerability?
url: https://github.com/ai-openshell/sdk-python/blob/main/SECURITY.md
about: >
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body:

Describe who needs the feature, the problem it solves, why the current gap matters, the API you would like to use, and the observable criteria for success. Leave implementation choices to the people building the feature.

The SDK wraps the OpenShell gateway's API. A feature that needs a new gateway capability starts in [NVIDIA/OpenShell](https://github.com/NVIDIA/OpenShell/issues); link that issue here.
The SDK wraps the OpenShell gateway's API. A feature that needs a new gateway capability starts in [ai-openshell/openshell](https://github.com/ai-openshell/openshell/issues); link that issue here.

- type: textarea
id: user-story
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:

- uses: jdx/mise-action@b44d12e7d0d8ee7461bb893e1b1993500433185b # v5.2.7

# fetch-core.sh reads proto/ and sdk/conformance from NVIDIA/OpenShell
# fetch-core.sh reads proto/ and sdk/conformance from ai-openshell/openshell
# at the pinned ref (public, no credentials).
- name: Format, lint, typecheck, proto and fixture drift
run: mise run check
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NVIDIA/OpenShell/main/docs/brand/assets/openshell-banner-dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/NVIDIA/OpenShell/main/docs/brand/assets/openshell-banner-light.png">
<img alt="OpenShell" src="https://raw.githubusercontent.com/NVIDIA/OpenShell/main/docs/brand/assets/openshell-banner-light.png" width="430">
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ai-openshell/openshell/main/docs/brand/assets/openshell-banner-dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ai-openshell/openshell/main/docs/brand/assets/openshell-banner-light.png">
<img alt="OpenShell" src="https://raw.githubusercontent.com/ai-openshell/openshell/main/docs/brand/assets/openshell-banner-light.png" width="430">
</picture>

# Python SDK for OpenShell
Expand All @@ -11,7 +11,7 @@
[![Security policy](https://img.shields.io/badge/Security-Report%20a%20Vulnerability-red)](https://github.com/ai-openshell/sdk-python/blob/main/SECURITY.md)
[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen)](https://docs.nvidia.com/openshell/latest/sdk/python)

Use the Python SDK to manage [OpenShell](https://github.com/NVIDIA/OpenShell) sandboxes from applications, notebooks, and automation. Create sandboxes, run commands and Python functions, and manage templates, workspaces, and provider credentials through the gateway.
Use the Python SDK to manage [OpenShell](https://github.com/ai-openshell/openshell) sandboxes from applications, notebooks, and automation. Create sandboxes, run commands and Python functions, and manage templates, workspaces, and provider credentials through the gateway.

See the [Python SDK documentation](https://docs.nvidia.com/openshell/latest/sdk/python) for connection options, authentication, and generated gRPC bindings.

Expand Down
6 changes: 3 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
## Reporting a vulnerability

Report vulnerabilities in the OpenShell Python SDK privately through
[NVIDIA/OpenShell's private reporting
form](https://github.com/NVIDIA/OpenShell/security/advisories/new) and name
[ai-openshell/openshell's private reporting
form](https://github.com/ai-openshell/openshell/security/advisories/new) and name
`ai-openshell/sdk-python` as the affected component. Do not disclose
vulnerabilities in public issues, discussions, or pull requests.

The OpenShell security policy applies to this repository: the [report template,
review process, and coordinated
disclosure](https://github.com/NVIDIA/OpenShell/blob/main/SECURITY.md) are the
disclosure](https://github.com/ai-openshell/openshell/blob/main/SECURITY.md) are the
same. Private reporting directly on this repository will be enabled once its
process is set up; until then, use the form above.
2 changes: 1 addition & 1 deletion mise.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ run = """
#!/usr/bin/env bash
set -euo pipefail
rm -rf proto
buf export "https://github.com/NVIDIA/OpenShell.git#ref=${OPENSHELL_CORE_REF},depth=1,subdir=proto" \
buf export "https://github.com/ai-openshell/openshell.git#ref=${OPENSHELL_CORE_REF},depth=1,subdir=proto" \
--path openshell.proto --path credential_driver.proto --output proto
"""
sources = ["mise.toml"]
Expand Down
2 changes: 1 addition & 1 deletion scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The workflows use a GitHub App token from the `sdk-bot` environment (secrets `SD

| File | mise task | Purpose |
|------|-----------|---------|
| `core-tags.sh [--all]` | `core:tags` | List NVIDIA/OpenShell release tags newer than the pin: every stable tag, plus the newest pre-release when it is newer than all of them. |
| `core-tags.sh [--all]` | `core:tags` | List ai-openshell/openshell release tags newer than the pin: every stable tag, plus the newest pre-release when it is newer than all of them. |
| `open-bump-pr.sh <tag> [--dry-run]` | `core:bump` | Open the update proposal for one core tag: branch `core/<tag>`, pin change, regenerated bindings, refreshed copies of core files, proto diff in the body, labels `core-bump` plus `stable` or `prerelease`. Closes older pre-release proposals. |
| `bump-pr-body.md` | | PR body template for `open-bump-pr.sh`. |
| `drift-check.sh --out <file>` | `core:drift` | Compare core `main` with the pin: `buf breaking`, regenerate and run the unit tests, list the RPCs the SDK doesn't call. Writes the markdown report. |
Expand Down
4 changes: 2 additions & 2 deletions scripts/core-sync/core-tags.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: Apache-2.0

# core-tags.sh: print NVIDIA/OpenShell release tags newer than the pin,
# core-tags.sh: print ai-openshell/openshell release tags newer than the pin,
# oldest first.
#
# Usage: core-tags.sh [--all] [--pin <tag>]
Expand All @@ -14,7 +14,7 @@
# must be a release tag; a commit SHA fails.
set -euo pipefail

repo=${CORE_REPO:-NVIDIA/OpenShell}
repo=${CORE_REPO:-ai-openshell/openshell}
all=0
pin=

Expand Down
2 changes: 1 addition & 1 deletion scripts/core-sync/drift-check.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# check. Exits 0 when checks 1 and 2 pass, 1 otherwise.
set -euo pipefail

core_url=${CORE_URL:-https://github.com/NVIDIA/OpenShell.git}
core_url=${CORE_URL:-https://github.com/ai-openshell/openshell.git}
out=
while [ $# -gt 0 ]; do
case $1 in
Expand Down
2 changes: 1 addition & 1 deletion scripts/core-sync/open-bump-pr.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
# Git identity and GH_TOKEN come from the environment (the App in CI).
set -euo pipefail

core_repo=${CORE_REPO:-NVIDIA/OpenShell}
core_repo=${CORE_REPO:-ai-openshell/openshell}
sdk_repo=${SDK_REPO:-ai-openshell/sdk-python}
image=ghcr.io/nvidia/openshell/gateway
diff_cap=400
Expand Down
2 changes: 1 addition & 1 deletion scripts/e2e/start-gateway.sh
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
# including sandboxes of another local gateway that uses the same namespace.
set -euo pipefail

core_repo=${CORE_REPO:-NVIDIA/OpenShell}
core_repo=${CORE_REPO:-ai-openshell/openshell}
registry=ghcr.io/nvidia/openshell
name=e2e
port=8080
Expand Down
4 changes: 2 additions & 2 deletions scripts/fetch-core.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0

# fetch-core.sh: copy files from NVIDIA/OpenShell at a pinned ref.
# fetch-core.sh: copy files from ai-openshell/openshell at a pinned ref.
#
# The protos come from `buf export` (mise run proto:fetch); this script fetches
# the other core files the repository checks against, such as the vendored
Expand All @@ -23,7 +23,7 @@ fi
ref=$1
out=$2
shift 2
remote=${OPENSHELL_CORE_REMOTE:-https://github.com/NVIDIA/OpenShell.git}
remote=${OPENSHELL_CORE_REMOTE:-https://github.com/ai-openshell/openshell.git}
work=$(mktemp -d)
trap 'rm -rf "$work"' EXIT

Expand Down
2 changes: 1 addition & 1 deletion scripts/vendored-core-files.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SPDX-License-Identifier: Apache-2.0
#
# Files copied from NVIDIA/OpenShell at the pinned ref, one per line:
# Files copied from ai-openshell/openshell at the pinned ref, one per line:
# <path in core> <path here>. `mise run vendored:check` fails when a copy
# differs from core, and core bump PRs refresh them (core-sync/open-bump-pr.sh).
sdk/conformance/oauth-client-credentials.json tests/fixtures/oauth-client-credentials.json
Expand Down
Loading