SDK for creating ISCCs (International Standard Content Codes)
Project description
ISCC - Software Development Kit
iscc-sdk is a Python development kit for creating and managing ISCC
(International Standard Content Code)
What is an ISCC
The ISCC is a similarity preserving identifier for digital media assets.
ISCCs are generated algorithmically from digital content, just like cryptographic hashes. However, instead of using a single cryptographic hash function to identify data only, the ISCC uses various algorithms to create a composite identifier that exhibits similarity-preserving properties (soft hash).
The component-based structure of the ISCC identifies content at multiple levels of abstraction. Each component is self-describing, modular, and can be used separately or with others to aid in various content identification tasks. The algorithmic design supports content deduplication, database synchronization, indexing, integrity verification, timestamping, versioning, data provenance, similarity clustering, anomaly detection, usage tracking, allocation of royalties, fact-checking and general digital asset management use-cases.
What is iscc-sdk
iscc-sdk is built on top of iscc-core and adds high level features for generating and handling
ISCC codes for all the different mediatypes:
- mediatype detection
- metadata extraction and embedding
- mediatype specific content extraction and pre-processing
- iscc indexing and search
Requirements
Python 3.8 to 3.11 on 64-bit systems
Installation
Use the Python package manager pip to install iscc-sdk.
pip install iscc-sdk
Getting Started
Create an ISCC-CODE for a media file:
import iscc_sdk as idk
print(idk.code_iscc("/path/to/mediafile.jpg"))
Using the CLI tool to create an ISCC-CODE
idk create /path/to/mediafile.jpg
Batch creation of ISCC-CODEs
idk batch /folder_with_media_files
Documentation
Troubleshooting
On Linux and MacOS you might need to install taglib as a prerequisite. On Ubuntu, Mint and other Debian-Based distributions do:
sudo apt install libtag1-dev
On a Mac, use HomeBrew:
brew install taglib
Project Status
The ISCC has been accepted by ISO as full work item ISO/AWI 24138 - International Standard Content Code and is currently being standardized at TC 46/SC 9/WG 18. https://www.iso.org/standard/77899.html
!!! attention
The iscc-sdk library and the accompanying documentation is under development. API changes and
other backward incompatible changes are to be expected until the upcoming v1.5 stable release.
Maintainers
Contributing
Pull requests are welcome. For significant changes, please open an issue first to discuss your plans. Please make sure to update tests as appropriate.
You may also want join our developer chat on Telegram at https://t.me/iscc_dev.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
