Skip to main content

Open source metadata processing framework

Project description

offchain

Documentation | Zora API


offchain is a library for parsing NFT metadata. It's used by Zora's indexer & API. It can handle metadata of many standards (OpenSea, ZORA, Nouns), hosted in many places (ipfs, http, dataURIs), and normalize them into a consistent format.

Our goal with this project is to democratize access to NFT metadata.

pip install offchain
from offchain import MetadataPipeline, Token

pipeline = MetadataPipeline()
token = Token(
    collection_address="0x5180db8f5c931aae63c74266b211f580155ecac8",
    token_id=9559
)
metadata = pipeline.run([token])[0]

metadata.name               # -> 'antares the improbable'
metadata.description        # -> 'You are a WITCH who bathes in the tears of...'
metadata.standard           # -> OPENSEA_STANDARD
metadata.attributes         # -> [Attribute(trait_type='Skin Tone', ...]
metadata.image              # -> MediaDetails(size=2139693, sha256=None, uri='https://cryptocoven.s3.amazonaws.com/2048b255aa1d02045eef13cdd7100479.png', mime_type='image/png')
metadata.additional_fields  # -> [MetadataField(...), ...]

See documentation for more examples and tutorials.

Contributing

We welcome contributions that add support for new metadata standards, new ways of retreiving metadata, and ways of normalizing them to a consistent form. We are commited to integrating contributions to our indexer and making the results available in our API.

You should be able to contribute a new standard for metadata, and have NFTs that adhere to that metadata standard be returned correctly from queries to api.zora.co. We hope this helps to foster innovation in how NFTs are represented, where metadata is stored, and what is expressed in that metadata.

Features

  • Multiple metadata standards: represent metadata any way you wish
  • Multiple transport protocols: store metadata where you want
  • Composible for custom applications: only parse the standards you care about
  • Future proof: extensible to new formats, locations, etc. The more gigabrain the better.

Development

This project is developed using Python 3.9. Here's a recommended setup:

Poetry

This project uses poetry for dependency management and packaging. Install poetry:

curl -sSL https://install.python-poetry.org | python3 -

Setup

poetry install

Pre-commit

Pre-commit runs checks to enforce coding standards on every commit

pip install pre-commit  # into global python path
pre-commit install

Testing

poetry run python -m pytest tests/

Documentation

This project uses mkdocs and mkdocs-material for documentation.

poetry run mkdocs serve

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

offchain-0.3.4.tar.gz (36.2 kB view details)

Uploaded Source

Built Distribution

offchain-0.3.4-py3-none-any.whl (64.5 kB view details)

Uploaded Python 3

File details

Details for the file offchain-0.3.4.tar.gz.

File metadata

  • Download URL: offchain-0.3.4.tar.gz
  • Upload date:
  • Size: 36.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/5.15.0-1061-azure

File hashes

Hashes for offchain-0.3.4.tar.gz
Algorithm Hash digest
SHA256 44c8d5f1c3cae9e68f24bb5daa7e288b798026f22f3dc08658504a23386654e1
MD5 168a2235347d3c9fb0c0db6215fb07e3
BLAKE2b-256 1426b4fb297867aebdb0108564b84d221425ca93d8145b8282823a3b8d77935f

See more details on using hashes here.

File details

Details for the file offchain-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: offchain-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 64.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/5.15.0-1061-azure

File hashes

Hashes for offchain-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c645b0c4822a08652a09e6ff86b2a59dc7dac3f634bd489b11c22309ba3dab31
MD5 943b2b52a02a9dd5b2824817c5ff0032
BLAKE2b-256 e6b9c04caf47afcb160978389669050b79e710f492d70b0c2101fb2613f99649

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