Skip to main content

Python wrapper for cardano-cli for working with cardano cluster

Project description

Documentation Status PyPi Version

README for cardano-clusterlib

Python wrapper for cardano-cli for working with cardano cluster.

Installation

# create and activate virtual env
$ python3 -m venv .env
$ . .env/bin/activate
# install it from PyPI
$ pip install cardano-clusterlib
# - OR - install it in develop mode together with dev requirements
$ make install

Usage

Needs working cardano-cli (the command is available on PATH, cardano-node is running, CARDANO_NODE_SOCKET_PATH is set). In state_dir it expects "shelley/genesis.json".

from cardano_clusterlib import clusterlib

cluster = clusterlib.ClusterLib(state_dir="path/to/cluster/state_dir")

destinations = [clusterlib.TxOut(address=dst_address, amount=amount_lovelace)]
tx_files = clusterlib.TxFiles(signing_key_files=[src_skey_file])

tx_raw_output = cluster.send_funds(
    src_address=src_address,
    destinations=destinations,
    tx_name="send_funds",
    tx_files=tx_files,
)
cluster.wait_for_new_block(new_blocks=2)

cluster.get_utxo(src_address)

See cardano-node-tests for more examples.

Source Documentation

https://cardano-clusterlib-py.readthedocs.io/en/latest/cardano_clusterlib.html

Contributing

Install this package and its dependencies as described above.

Run pre-commit install to set up the git hook scripts that will check you changes before every commit. Alternatively run make lint manually before pushing your changes.

Follow the Google Python Style Guide, with the exception that formatting is handled automatically by Black (through pre-commit command).

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

cardano-clusterlib-0.1.4.tar.gz (25.9 kB view details)

Uploaded Source

Built Distribution

cardano_clusterlib-0.1.4-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file cardano-clusterlib-0.1.4.tar.gz.

File metadata

  • Download URL: cardano-clusterlib-0.1.4.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.2 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for cardano-clusterlib-0.1.4.tar.gz
Algorithm Hash digest
SHA256 638b5b5191f2fe9e00e03361fec43b06865dc6600d34a6bca9bb3d4943484931
MD5 c41a3d6ced7c899a27f17408d4892abd
BLAKE2b-256 cb6a547660c5d526f47ce2bcc8df67b8914253cf5f109290fd941104b106bd93

See more details on using hashes here.

File details

Details for the file cardano_clusterlib-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: cardano_clusterlib-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.2 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for cardano_clusterlib-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5b2326881601c09e2bfe2678864a74f9ddc832d590292d309b7d634191f1f078
MD5 e9e2b9a8c7b9da5edf394b1b96d05fb6
BLAKE2b-256 0b8e4cf1f58eb7d090d990ecd32cd59c01359219146514fabd50417cf9507589

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