zicon-cli 0.2.0

Command line interface for the ZiCON Cloud API, built on the zicon-cloud SDK.

zicon-cli

A command line interface for the ZiCON Cloud API, built on top of the zicon-cloud Python SDK.

Install

pip install zicon-cli

This installs a zicon command on your PATH.

Authentication

Dataset, tool, and endpoint discovery commands work without any credentials. Project management commands require a ZiCON API key.

Set it as an environment variable:

export ZICON_API_KEY="your-api-key"

or pass it per-command with --api-key:

zicon projects list --api-key your-api-key

If a command needs an API key and neither the environment variable nor --api-key is provided, zicon prints an error explaining how to fix it and exits.

Usage

Datasets

List all available datasets:

zicon datasets list

Get full details for a single dataset:

zicon datasets get <dataset-id>

Get the download URL for a dataset's file:

zicon datasets download <dataset-id>

Tools

List tools available in the ZiCON ecosystem (name, language, install command):

zicon tools list

Endpoints

List the ZiCON Cloud API's HTTP endpoints (method, path, description):

zicon endpoints list

Projects (requires an API key)

List your projects:

zicon projects list

List the files belonging to a project:

zicon projects files <project-id>

Delete a project (prompts for confirmation before deleting):

zicon projects delete <project-id>

Errors

zicon catches the errors raised by the zicon-cloud SDK and prints a clean message instead of a Python traceback:

• ZiconAuthError — missing or invalid credentials
• ZiconPermissionError — credentials are valid but not permitted to perform the action
• ZiconNotFoundError — the requested resource does not exist
• ZiconServerError — the ZiCON Cloud API returned a server error

License

MIT