Repository files navigation

A comprehensive Python toolkit for creating and managingISCC(International Standard Content Code) identifiers for digital media assets.

TheInternational Standard Content Code (ISCC) is a content-dependent, similarity-preservingidentifier and fingerprint system for digital content, standardized asISO 24138:2024.

ISCCs are neither manually nor automatically assigned but are derived from the digital contentitself. Generated algorithmically using various hash algorithms, ISCCs create composite identifierswith similarity-preserving properties (soft hashes) that can be independently derived by unrelatedparties from the same media asset.

Digital content is dynamic - continuously re-encoded, resized, and re-compressed as it travelsthrough complex networks. The ISCC remains robust across these transformations while preservingestimates of data, content, and metadata similarity.

The component-based structure of ISCC identifies content at multiple levels of abstraction, creatinga multi-layered fingerprint. These components work together to create a robust,similarity-preserving identifier that remains stable despite modifications to the underlying digitalasset. With this multi-layered approach, the ISCC can track content throughout its lifecycle, evenas it's re-encoded, resized, or re-compressed.

Each component is self-describing, modular, and can be used separately or together, enabling ISCCsto support numerous digital asset management use-cases across all domains concerned with producing,processing, and distributing digital information (science, journalism, books, music, film, etc.):

• Content deduplication and discovery
• Database synchronization and indexing
• Integrity verification and timestamping
• Versioning and data provenance tracking
• Similarity clustering and matching
• Anomaly detection in content collections
• Usage tracking and royalty allocation
• Fact-checking and content verification
• Interoperability between different systems and actors
• Association with higher-level identifiers (work/product identifiers)

iscc-sdk builds on top ofiscc-core to provide high-level features for generating and handlingISCC codes across different media types. It serves as a complete toolkit for implementing ISCC-basedworkflows in Python applications.

• Comprehensive Media Support: Process text, image, audio, and video files
• Mediatype Detection: Automatically identify file formats
• Metadata Management: Extract and embed metadata across different file formats
• Content Processing: Handle mediatype-specific content extraction and normalization
• Rich CLI: Command-line interface for easy integration into workflows
• Cross-Platform: Works on Windows, macOS, and Linux
• Built-in Tools: Includes necessary binaries for media processing
• Standards Compliant: Build on top of the ISO 24138:2024 reference implementation

• Python 3.9 to 3.13 on 64-bit systems
• Supported platforms: Windows, macOS, Linux

pip install iscc-sdk

poetry add iscc-sdk

importiscc_sdkasidk# Generate a complete ISCC codeiscc_meta=idk.code_iscc("/path/to/mediafile.jpg")print(iscc_meta.iscc)# Full ISCC codeprint(iscc_meta.json(indent=2))# All metadata as JSON# Generate specific ISCC componentsmeta_code=idk.code_meta("/path/to/mediafile.jpg")content_code=idk.code_content("/path/to/mediafile.jpg")data_code=idk.code_data("/path/to/mediafile.jpg")instance_code=idk.code_instance("/path/to/mediafile.jpg")# Process specific media typestext_code=idk.code_text("/path/to/document.pdf")image_code=idk.code_image("/path/to/image.png")audio_code=idk.code_audio("/path/to/audio.mp3")video_code=idk.code_video("/path/to/video.mp4")

importiscc_sdkasidkfromiscc_schemaimportIsccMeta# Extract metadatametadata=idk.extract_metadata("/path/to/mediafile.jpg")# Create custom metadatacustom_meta=IsccMeta(name="My Asset Title",description="Description of the asset",creator="Creator Name",license="https://creativecommons.org/licenses/by/4.0/")# Embed metadata into a copy of the filenew_file=idk.embed_metadata("/path/to/mediafile.jpg",custom_meta)

The SDK includes a command-line interface calledidk.

idk create /path/to/mediafile.jpg

idk batch /folder_with_media_files

idk install

idk selftest

For complete documentation, visithttps://sdk.iscc.codes

The ISCC is an official standard published asISO 24138:2024 - International Standard Content CodewithinISO/TC 46/SC 9/WG 18.

Note: Theiscc-sdk library and the accompanying documentation are under active development.API changes and other backward incompatible changes are to be expected until a v1.0 stablerelease.

Contributions are welcome! Here's how you can help:

1. Issues: Report bugs or suggest features via theissue tracker
2. Pull Requests: Submit PRs for bug fixes or new features
3. Discussion: For significant changes, please open an issue first to discuss your plans
4. Testing: Please make sure to update tests as appropriate

Join our developer chat on Telegram athttps://t.me/iscc_dev.

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.