mycelium-client

This is the official reference implementation of the Mycelium client software, written in Python. It comes with a library for Python applications, as well as a CLI for end-users.

Usage

As a CLI

In order to use the Mycelium client as a CLI, you need to install the mycelium-client[cli] variant:

pip3 install mycelium-client[cli]

Once that's done, you can get help information with mycelium-client --help:

$ mycelium-client --help
Usage: mycelium-client [OPTIONS] [COMMAND] [ARGS]...

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  fetch
  show

As a Python library

The Mycelium client includes experimental support for use as a Python library without installing the CLI dependencies (this is what's supplied with the normal mycelium-client package):

import mycelium_client as mycelium
mycelium.fetch_hash(asset_hash="abcdef123...", oak="http://example.com:8000/", use_tqdm=False, quiet=True, timeout=15) # Fetch a hash.

mycelium.show_entries_md(filter_hash="", oak="http://example.com:8000/") # Generate human-readable Markdown describing the current entries advertised by an Oak. Leave filter_hash blank to disable hash filtering; set to a hash to filter for it.

Make sure to use version pinning whenever you're writing code that depends on mycelium-client, as it has breaking changes frequently and is still very much not ready for production.