nucleus-sdk 0.1a1

The building block for decentralized media

Nucleus

---

NOTE! Nucleus is alpha-stage software. It means nucleus hasn't been security audited and programming APIs and data formats can still change.

Nucleus is a collection of low-level tools for media decentralization. It offers functionalities to make it easier to process, store, and distribute multimedia in a decentralized way.

The key features of Nucleus include:

• Metadata harvesting
• Multimedia processing
• Multimedia storage
• Metadata distribution
• Web3 instruments

Nucleus follows a modular and layered design approach, consisting of the following layers:

1. The Core: This layer contains the building block packages that have minimal or no external dependencies. Any dependencies within the core layer will be limited to other internal packages.

2. The SDK: The SDK exposes the programming-level API to interact with the core functions in a safe and conformant way.

3. The CLI and HTTP API: These components utilize the SDK to provide services through command-line interfaces (CLI) and HTTP API endpoints.

Summary

Nucleus proposes a sequence of steps (pipeline) for the processing and decentralization of multimedia:

1. Harvesting: Collect metadata associated with the multimedia content.
2. Processing: Performing media processing tasks.
3. Storage: Store the processed content in the IPFS network.
4. Expose: Distribute metadata through the IPFS ecosystem.
5. Mint: Create metadata as NFTs (Non-Fungible Tokens).
6. Retrieval: Retrieve and unmarshal metadata for further distribution.

The pipeline design follows the decoupling principle, allowing for flexible use cases. For example, the storage component can be optional if data is already stored on the IPFS network. Similarly, the mint component can be skipped if there is no need to create NFTs for the metadata. The processing component may also be unnecessary if the media is already prepared for storage.

The Retrieval component facilitates the retrieval and unmarshalling of metadata from IPFS ecosystem, which can then be distributed through various means. eg.OrbitDB, Gun, etc..

Installing

You can use pip to install nucleus with e.g.:

pip install nucleus-sdk

Before using nucleus, FFmpeg and IPFS must be installed.

1. Check the official docs to install IPFS.
2. There are a variety of ways to install FFmpeg, such as the official download links, or using your package manager of choice (e.g. sudo apt install ffmpeg on Debian/Ubuntu, brew install ffmpeg on OS X, etc.).

Examples

• Full Pipeline

Development

Some available capabilities for dev support:

• Install: make install
• Tests: make test
• Debug: make debug
• Lint: make lint
• Lint Fix: make format

Note: Please check Makefile for more capabilities.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

phillmac 💻 📓 🤔 🚇

Mark Robert Henderson 💻 🤔

Echedenyan 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!