API reference
Generated from docstrings by starlight-pydocs when the site builds.
Conventions
Section titled “Conventions”- Only names exported from the top-level
ocx_sdkpackage (and the one public submodule,ocx_sdk.bootstrap) are public. Everything reachable through any other underscored module path is package-private and may change without notice — pre-1.0, breaking changes ship without shims. - Docstrings follow Google style.
Raises:sections list every exception a method may raise from the SDK’s own hierarchy; lower-layer exceptions are wrapped and preserved on__cause__.- Every method mirrors one ocx command; see the command ↔ method map for the full correspondence, and environment & exit codes for the wire-level detail behind the typed surface.
Every symbol has its own page; Ocx, Project and PackageCommands span several.
- Overview: the package overview
- Ocx (1 of 4): Ocx
- Ocx (2 of 4): Ocx
- Ocx (3 of 4): Ocx
- Ocx, Project: Ocx, Project
- Project (1 of 6): Project
- Project (2 of 6): Project
- Project (3 of 6): Project
- Project (4 of 6): Project
- Project (5 of 6): Project
- Project, PackageCommands: Project, PackageCommands
- PackageCommands (1 of 16): PackageCommands
- PackageCommands (2 of 16): PackageCommands
- PackageCommands (3 of 16): PackageCommands
- PackageCommands (4 of 16): PackageCommands
- PackageCommands (5 of 16): PackageCommands
- PackageCommands (6 of 16): PackageCommands
- PackageCommands (7 of 16): PackageCommands
- PackageCommands (8 of 16): PackageCommands
- PackageCommands (9 of 16): PackageCommands
- PackageCommands (10 of 16): PackageCommands
- PackageCommands (11 of 16): PackageCommands
- PackageCommands (12 of 16): PackageCommands
- PackageCommands (13 of 16): PackageCommands
- PackageCommands (14 of 16): PackageCommands
- PackageCommands (15 of 16): PackageCommands
- PackageCommands (16 of 16): PackageCommands
- ConfigCommands, PatchCommands: ConfigCommands, PatchCommands
- Auth to Channel: Auth, BasicAuth, BearerAuth, Channel
- ComposedEnv, ConfigOverrides: ComposedEnv, ConfigOverrides
- ConfigOverrides (1 of 2): ConfigOverrides
- ConfigOverrides (2 of 2): ConfigOverrides
- ConstVar, DistSource: ConstVar, DistSource
- DistSource (1 of 2): DistSource
- DistSource to Forge: DistSource, EnvEntryType, EnvValue, Forge
- HostEnv: HostEnv
- InstallEnv, LazyMode: InstallEnv, LazyMode
- ListVar to MaybeTimeout: ListVar, LogLevel, MANAGED_CONFIG_DISABLED, MIN_SUPPORTED, MaybeRetry, MaybeTimeout
- OcxConfig (1 of 3): OcxConfig
- OcxConfig (2 of 3): OcxConfig
- OcxConfig, PackageLike: OcxConfig, PackageLike
- PackageRef, PathVar, Resolve: PackageRef, PathVar, Resolve
- RetryPolicy: RetryPolicy
- SignatureFormat to ensure: SignatureFormat, TESTED_OCX_VERSION, Transport, UNSET, ensure
- AboutInfo (1 of 2): AboutInfo
- AboutInfo, Advisory: AboutInfo, Advisory
- AnnounceReport (1 of 2): AnnounceReport
- AnnounceReport (2 of 2): AnnounceReport
- Assertion: Assertion
- AttestationOutcome: AttestationOutcome
- AttestationReport (1 of 2): AttestationReport
- AttestationReport (2 of 2): AttestationReport
- BlobSummary: BlobSummary
- BuildReceipt: BuildReceipt
- Candidate: Candidate
- CapabilityCheck: CapabilityCheck
- CascadeCheckReport: CascadeCheckReport
- CascadeRepairReport: CascadeRepairReport
- CascadeReport (1 of 2): CascadeReport
- CascadeReport, ClaimOwner: CascadeReport, ClaimOwner
- ClaimReport (1 of 2): ClaimReport
- ClaimReport (2 of 2): ClaimReport
- CleanEntry: CleanEntry
- CommandResult, ConfigSetupReport: CommandResult, ConfigSetupReport
- ConfigUpdateReport (1 of 2): ConfigUpdateReport
- ConfigUpdateReport, CopiedPlatformRow: ConfigUpdateReport, CopiedPlatformRow
- CopyReport (1 of 2): CopyReport
- CopyReport (2 of 2): CopyReport
- DepNode: DepNode
- DepsReport: DepsReport
- DryRunEntry: DryRunEntry
- EnvEntry: EnvEntry
- EnvReport (1 of 2): EnvReport
- EnvReport, ErrorEnvelope: EnvReport, ErrorEnvelope
- ErrorEnvelope: ErrorEnvelope
- GroupStatus: GroupStatus
- IndexFinding, InfoResult: IndexFinding, InfoResult
- InspectReport: InspectReport
- InspectedPackage (1 of 2): InspectedPackage
- InspectedPackage, InstallReport: InspectedPackage, InstallReport
- InstalledPackage: InstalledPackage
- Integration: Integration
- ListingSummary: ListingSummary
- LockStatus: LockStatus
- LoginResult, LogoutResult: LoginResult, LogoutResult
- PackageBinding: PackageBinding
- PackageDescription: PackageDescription
- PullReport, PushResult: PullReport, PushResult
- PushResult: PushResult
- RefusedEntry: RefusedEntry
- RemovalResult: RemovalResult
- RepairEntry: RepairEntry
- RepairOutcome: RepairOutcome
- SbomEntry (1 of 2): SbomEntry
- SbomEntry, SbomListingReport: SbomEntry, SbomListingReport
- SbomSummaryOut: SbomSummaryOut
- SignatureEntry (1 of 2): SignatureEntry
- SignatureEntry, SignatureLegReport: SignatureEntry, SignatureLegReport
- SignatureReport (1 of 2): SignatureReport
- SignatureReport (2 of 2): SignatureReport
- SignedPlatformReport: SignedPlatformReport
- SlotRow: SlotRow
- StatusReport: StatusReport
- SweepReport: SweepReport
- SweptTagReport: SweptTagReport
- TestResult: TestResult
- TestRun: TestRun
- ToolBinding: ToolBinding
- ToolRow: ToolRow
- VerificationReport: VerificationReport
- VersionInfo: VersionInfo
- WhichResult, error_envelope: WhichResult, error_envelope
- partial_report, tolerated_report: partial_report, tolerated_report
- AuthError to ExitCode: AuthError, BootstrapError, ChecksumMismatchError, ConfigError, DataError, DirtyRcBlockError, DistManifestError, DownloadError, ExitCode
- ExitCode (1 of 2): ExitCode
- ExitCode to OcxError: ExitCode, ForgeCapabilityUnavailableError, IoError, NotFoundError, OcxError
- OcxExecutionError, OcxNotFoundError: OcxExecutionError, OcxNotFoundError
- OcxProcessError, OcxTimeoutError: OcxProcessError, OcxTimeoutError
- PermissionDeniedError to UsageError: PermissionDeniedError, PolicyBlockedError, ReferrersUnsupportedError, TempFailError, TransparencyLogUnavailableError, UnavailableError, UnsupportedKeyBackendError, UnsupportedPlatformError, UsageError
- VersionCompatError: VersionCompatError