ogmios-python
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.
Table of Contents
Installation
- Install cardano-node and Ogmios server as described here. (Docker installation is recommended.)
- Install ogmios-python from PyPI 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 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:
direction, tip, point, _ = client.next_block.execute()
if direction == ogmios.Direction.forward:
print(f"New block: {point}")
For more examples, see the documentation and example scripts in the repo.
Documentation
Complete client documentation is available on Read the Docs.
License
ogmios-python is distributed under the terms of the GPL-3.0-or-later license.
1 maintainer
Metadata
1 maintainer
Release files for ogmios 1.4.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ogmios-1.4.3.tar.gz | 114.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ogmios-1.4.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 243.6 kB
Release files / ogmios-1.4.3.tar.gz
| Download URL | ogmios-1.4.3.tar.gz |
|---|---|
| Size | 114.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f9e756df83be385f89c82a194a3c51c0a4ba25e5df699dfcfb2914a57c012754
|
|
BLAKE2b-256 checksum How to use checksums |
f4a5713afcc13265f70685dc8e8fb2bcf9dbef0d64e2f44b46280e7a1caab7bc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.7
|
Release files / ogmios-1.4.3-py3-none-any.whl
| Download URL | ogmios-1.4.3-py3-none-any.whl |
|---|---|
| Size | 128.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6d6eb9e2c577d71a90ab4dd72112990933dd29e3d7fb58053f9009ddc53db358
|
|
BLAKE2b-256 checksum How to use checksums |
d6e03c9ce6307a538af8273a07a0a51b06cc34a3c1017189821c86b30a01ce93
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.7
|
