Skip to main content

Software developer kit for creating ISCCs (International Standard Content Codes)

Project description

ISCC - Software Development Kit

Build Version Coverage Quality Downloads

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.10

On Linux and MacOS taglib needs to be installed 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

Installation

Use the Python package manager pip to install iscc-sdk.

pip install iscc-sdk

Documentation

https://sdk.iscc.codes

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

@titusz

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.

Changelog

0.4.2 - 2022-04-27

  • Fix metadata extraction failure with long texts
  • Embed Dublin Core metadata in images
  • Support path object inputs for text_name_from_uri

0.4.1 - 2022-03-26

  • Added video thumbnail support
  • Added support for IPFS wrap-with-directory

0.4.0 - 2022-03-21

  • Added Text-Code generation
  • Added Video-Code generation
  • Added text document metadata extraction
  • Added video metadata embedding and extraction
  • Added custom exeptions
  • Changed embedding to create a new mediafile
  • Set filename on IsccMeta
  • Set @type on IsccMeta

0.3.0 - 2022-03-12

  • Added support for Audio-Code with metadata embedding/extraction

0.2.0 - 2022-03-10

  • Added IPFS support

0.1.0 - 22022-03-09

  • Initial release with support for ISCC Content-Code Image

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iscc-sdk-0.4.2.tar.gz (24.3 kB view details)

Uploaded Source

File details

Details for the file iscc-sdk-0.4.2.tar.gz.

File metadata

  • Download URL: iscc-sdk-0.4.2.tar.gz
  • Upload date:
  • Size: 24.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.10.1 Windows/10

File hashes

Hashes for iscc-sdk-0.4.2.tar.gz
Algorithm Hash digest
SHA256 d323da979168bc210a4f685a095b935581e4e56a11bfd8133ccf56c2c2693942
MD5 3584cb06897d54a844361e55f2c561e4
BLAKE2b-256 3570dc2342d9229e9573a6381b2cb2668ac035c491f5c938c5b2048d2855a5c7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page