API reference

Auto-generated from docstrings via mkdocstrings.

Public symbols

Symbol	Module	Page
IndexBuilder	ocx_mirror_sdk.index	IndexBuilder
Asset, Release	ocx_mirror_sdk.releases	Releases
github.list_releases, github.Backend	ocx_mirror_sdk.github	Releases
gitlab.list_releases	ocx_mirror_sdk.gitlab	Releases
FileCache, configure	ocx_mirror_sdk.cache	Cache
fetch_json, fetch_text, post_json	ocx_mirror_sdk.http	HTTP
extract_urls	ocx_mirror_sdk.text	Text
OcxMirrorError + subclasses	ocx_mirror_sdk.errors	Errors

Conventions

• All names exported from ocx_mirror_sdk are public; anything under ocx_mirror_sdk.<module>._foo is package-private. Release sources live in the github and gitlab subpackages — call them as github.list_releases(...) / gitlab.list_releases(...).
• Docstrings follow Google style.
• Raises: sections list every exception the function may raise from the SDK's hierarchy; lower-layer exceptions are wrapped (preserved on __cause__).