Skip to main content

cli

Access the NumerBay API via command line

CommonJSONEncoder Objects​

class CommonJSONEncoder(json.JSONEncoder)

Common JSON Encoder json.dumps(jsonString, cls=CommonJSONEncoder)

prettify​

def prettify(stuff)

prettify json

cli​

@click.group()
def cli()

Wrapper around the NumerBay API

account​

@cli.command()
def account()

Get all information about your account!

orders​

@cli.command()
def orders()

Get all your orders!

sales​

@cli.command()
def sales()

Get all your sales!

listings​

@cli.command()
def listings()

Get all your listings!

submit​

@cli.command()
@click.option("--product_id", type=int, default=None, help="NumerBay product ID")
@click.option(
    "--product_full_name",
    type=str,
    default=None,
    help="NumerBay product full name (e.g. numerai-predictions-numerbay), "
    "used for resolving product_id if product_id is not provided",
)
@click.option(
    "--order_id",
    type=int,
    default=None,
    help="NumerBay order ID, " "used for encrypted per-order artifact upload",
)
@click.argument("path", type=click.Path(exists=True))
def submit(path, product_id, product_full_name, order_id)

Upload artifact from file.

download​

@cli.command()
@click.option("--product_id", type=int, default=None, help="NumerBay product ID")
@click.option(
    "--product_full_name",
    type=str,
    default=None,
    help="NumerBay product full name (e.g. numerai-predictions-numerbay), "
    "used for resolving product_id if product_id is not provided",
)
@click.option(
    "--order_id",
    type=int,
    default=None,
    help="NumerBay order ID, " "used for encrypted per-order artifact download",
)
@click.option(
    "--artifact_id",
    type=int,
    default=None,
    help="Artifact ID for the file to download, \
    defaults to the first artifact for your active order for the product",
)
@click.option(
    "--key_path",
    type=str,
    default=None,
    help="path to buyer's exported NumerBay key file",
)
@click.option(
    "--key_base64",
    type=str,
    default=None,
    help="buyer's NumerBay private key base64 string (used for tests)",
)
@click.option("--filename", help="filename to store as")
@click.option(
    "--dest_path",
    help="complate path where the file should be stored, "
    "defaults to the same name as the source file",
)
def download(filename, dest_path, product_id, product_full_name, order_id, artifact_id, key_path, key_base64)

Download artifact file.

version​

@cli.command()
def version()

Installed numerbay version.