# 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.AboutInfo

*class* · *dataclass*

```python
class AboutInfo
```

Re-exported from: `ocx_sdk._results`

`ocx about` — the binary plus the host it is running on.

`channel` appears only when it was baked into the build. `shell` is
always on the wire and may be `null` (`about.rs:30`) — ocx detected no
shell — so it is the only one of the four leading fields that can be
`None`.

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

### ocx_sdk.AboutInfo.build

*attribute* · *class attribute* · *instance attribute*

```python
build: Mapping[str, Any] = _EMPTY
```

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

### ocx_sdk.AboutInfo.channel

*attribute* · *class attribute* · *instance attribute*

```python
channel: str | None = None
```

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

### ocx_sdk.AboutInfo.ci

*attribute* · *class attribute* · *instance attribute*

```python
ci: Mapping[str, Any] = _EMPTY
```

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

### ocx_sdk.AboutInfo.commit

*attribute* · *class attribute* · *instance attribute*

```python
commit: Mapping[str, Any] = _EMPTY
```

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

### ocx_sdk.AboutInfo.home

*attribute* · *instance attribute*

```python
home: str
```

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

### ocx_sdk.AboutInfo.libc

*attribute* · *class attribute* · *instance attribute*

```python
libc: tuple[str, ...] = ()
```

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

### ocx_sdk.AboutInfo.platforms

*attribute* · *class attribute* · *instance attribute*

```python
platforms: tuple[str, ...] = ()
```

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

### ocx_sdk.AboutInfo.registry

*attribute* · *instance attribute*

```python
registry: str
```

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

### ocx_sdk.AboutInfo.shell

*attribute* · *instance attribute*

```python
shell: str | None
```

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

### ocx_sdk.AboutInfo.version

*attribute* · *instance attribute*

```python
version: str
```

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