API Reference¶

Python bindings for the ISCC (ISO 24138:2024) code generation functions. All functions accept typed parameters and return JSON strings — use json.loads() to parse the result.

import json
from iscc_lib import gen_meta_code_v0

result = json.loads(gen_meta_code_v0("Example Title"))
print(result["iscc"])  # "ISCC:..."

Functions¶

High-performance ISCC (ISO 24138:2024) implementation backed by Rust.

IsccResult ¶

Bases: dict

ISCC result with both dict-style and attribute-style access.

MetaCodeResult ¶

Bases: IsccResult

Result of gen_meta_code_v0.

TextCodeResult ¶

Bases: IsccResult

Result of gen_text_code_v0.

ImageCodeResult ¶

Bases: IsccResult

Result of gen_image_code_v0.

AudioCodeResult ¶

Bases: IsccResult

Result of gen_audio_code_v0.

VideoCodeResult ¶

Bases: IsccResult

Result of gen_video_code_v0.

MixedCodeResult ¶

Bases: IsccResult

Result of gen_mixed_code_v0.

DataCodeResult ¶

Bases: IsccResult

Result of gen_data_code_v0.

InstanceCodeResult ¶

Bases: IsccResult

Result of gen_instance_code_v0.

IsccCodeResult ¶

Bases: IsccResult

Result of gen_iscc_code_v0.

gen_meta_code_v0 ¶

gen_meta_code_v0(
    name: str,
    description: str | None = None,
    meta: str | None = None,
    bits: int = 64,
) -> MetaCodeResult

Generate an ISCC Meta-Code from content metadata.

gen_text_code_v0 ¶

gen_text_code_v0(
    text: str, bits: int = 64
) -> TextCodeResult

Generate an ISCC Text-Code from plain text content.

gen_image_code_v0 ¶

gen_image_code_v0(
    pixels: bytes, bits: int = 64
) -> ImageCodeResult

Generate an ISCC Image-Code from pixel data.

gen_audio_code_v0 ¶

gen_audio_code_v0(
    cv: list[int], bits: int = 64
) -> AudioCodeResult

Generate an ISCC Audio-Code from a Chromaprint feature vector.

gen_video_code_v0 ¶

gen_video_code_v0(
    frame_sigs: list[list[int]], bits: int = 64
) -> VideoCodeResult

Generate an ISCC Video-Code from frame signature data.

gen_mixed_code_v0 ¶

gen_mixed_code_v0(
    codes: list[str], bits: int = 64
) -> MixedCodeResult

Generate an ISCC Mixed-Code from multiple Content-Code strings.

gen_data_code_v0 ¶

gen_data_code_v0(
    data: bytes, bits: int = 64
) -> DataCodeResult

Generate an ISCC Data-Code from raw byte data.

gen_instance_code_v0 ¶

gen_instance_code_v0(
    data: bytes, bits: int = 64
) -> InstanceCodeResult

Generate an ISCC Instance-Code from raw byte data.

gen_iscc_code_v0 ¶

gen_iscc_code_v0(
    codes: list[str], wide: bool = False
) -> IsccCodeResult

Generate a composite ISCC-CODE from individual ISCC unit codes.