Registry / devops / shipyard-python-sdk

shipyard-python-sdk

library0.2.4pypypi✓ verified 84d ago

Shipyard Python SDK (v0.2.4) provides programmatic access to Shipyard's agent sandbox environment for building and managing Python agents. Requires Python >=3.10.

devops ai-ml

pip install shipyard-python-sdk

INSTALL

IMPORT

SIG · SHIPYARD-PYTHON-SD

shipyard-python-sdk

devopspythonv0.2.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ShipyardClient

✓ from shipyard.client import ShipyardClient

The correct import path uses the 'shipyard' package, not 'shipyard_sdk' or 'shipyard-python-sdk'.

Config

✓ from shipyard.config import Config

Initialize client with API key from environment variable and list agents.

import os from shipyard.client import ShipyardClient from shipyard.config import Config config = Config(api_key=os.environ.get('SHIPYARD_API_KEY', '')) client = ShipyardClient(config=config) response = client.agents.list() print(response)

Debug

Known issues

breakingThe SDK is in early alpha (pre-1.0). Breaking changes may occur without major version bumps. Pin exact version in production.

fix

Use `shipyard-python-sdk==0.2.4` in requirements.txt

affects: <1.0.0

gotchaAPI key must be set via environment variable or passed directly to Config. Omitting it leads to authentication failures.

fix

Set SHIPYARD_API_KEY environment variable or pass `api_key` parameter.

affects: all

deprecatedOlder documentation may reference a top-level `shipyard` object with direct methods. These have been moved to submodules like `shipyard.client`.

fix

Use `from shipyard.client import ShipyardClient` instead of `import shipyard`.

affects: >=0.2.0

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'shipyard_sdk'

Using the wrong package name in import. The package is 'shipyard-python-sdk' on PyPI but the module is 'shipyard'.

fix

Run `pip install shipyard-python-sdk` and import using `from shipyard.client import ShipyardClient`.

AttributeError: module 'shipyard' has no attribute 'client'

Importing the top-level 'shipyard' module instead of submodules. The SDK uses a subpackage structure.

fix

Use explicit imports like `from shipyard.client import ShipyardClient`.

shipyard.exceptions.AuthenticationError: Invalid API key

API key is missing, incorrectly set, or expired.

fix

Check that SHIPYARD_API_KEY is set in environment or passed to Config, and ensure the key is valid.

Upgrade

Version history

0.2.4latest on PyPI · released Jan 13, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

21 hits · last 30 days

node

OpenAI (training)

Resources

No resource links recorded.