ogmios 0.1.3

Ogmios is a lightweight bridge interface for cardano-node. It offers a WebSockets API that enables local clients to speak Ouroboros' mini-protocols via JSON/RPC. ogmios-python is an Ogmios client written in Python designed for ease of use.

ogmios

---

Table of Contents

• Installation
• License

Installation

1. Install cardano-node and Ogmios server as described here. (Docker installation is recommended.)
2. Install ogmios-python using pip:

pip install ogmios

Quickstart

To see how easy it is to build on Cardano with ogmios-python, let's use the library to view new blocks as they are added to the blockchain:

import time
import ogmios

with ogmios.Client() as client:
    # Set chain pointer to origin
    _, tip, _ = client.find_intersection.execute([ogmios.Origin()])

    # Now set chain pointer to tip
    _, _, _ = client.find_intersection.execute([tip.to_point()])

    # # Tail blockchain as new blocks come in beyond the current tip
    while True:
        client.next_block.execute()
        time.sleep(1)

For more examples, see the documentation and example scripts in the repo.

License

ogmios-python is distributed under the terms of the GPL-3.0-or-later license.