# ocx_sdk

*module*

Python SDK for [OCX](https://github.com/ocx-sh/ocx).

`ocx-sdk` drives the ocx binary rather than reimplementing it: ocx owns
resolution, verification, and the identifier grammar, and this package gives
you typed, CWD-independent handles over the commands it exposes.

```python
from ocx_sdk import Ocx, bootstrap

ocx = Ocx(exe=bootstrap.ensure())
project = ocx.project("/srv/build")
project.pull()
project.exec(["task", "verify"])
```

**This module is the API.** Everything listed in `__all__` is the stable
surface; every other module is underscored and package-private, and the one
public submodule is `ocx_sdk.bootstrap`. Reaching into an underscored path
means the next release may move it without notice — pre-1.0, breaking
changes ship without shims.

Start at `Ocx` for the runtime API and `bootstrap.ensure` for provisioning.

[View source](https://github.com/ocx-sh/ocx-sdk-python/blob/main/src/ocx_sdk/__init__.py#L1-L1)

## ocx_sdk.VersionCompatError

*class*

```python
class VersionCompatError(OcxError)
```

Bases: `ocx_sdk._errors.OcxError`

Re-exported from: `ocx_sdk._errors`

The discovered ocx binary is older than this SDK supports.

**Attributes**

- `found` (`str`) — The version the binary reported.
- `minimum` (`str`) — The oldest version this SDK is tested against.

[View source](https://github.com/ocx-sh/ocx-sdk-python/blob/main/src/ocx_sdk/_errors.py#L354-L370)

### ocx_sdk.VersionCompatError.found

*attribute* · *instance attribute*

```python
found: str = found
```

[View source](https://github.com/ocx-sh/ocx-sdk-python/blob/main/src/ocx_sdk/_errors.py#L369-L369)

### ocx_sdk.VersionCompatError.minimum

*attribute* · *instance attribute*

```python
minimum: str = minimum
```

[View source](https://github.com/ocx-sh/ocx-sdk-python/blob/main/src/ocx_sdk/_errors.py#L370-L370)