Skip to content
Jordan Matelsky edited this page Apr 11, 2016 · 1 revision

ndio is split up into three main submodules: remotes, converts, and datatypes (such as ramon), which live in the top-level of the module (e.g. ndio.ramon). Their significance is explained below:

Remotes

A remote is defined as a service (generally a datastore) that lives at a remote IP or URI. ndio.remotes serve as gateways to these services, providing a Python API to allow interfacing with systems such as ndstore, DVID, and more.

Converts

A converter is a submodule that accepts data of one type and returns data of another type — quite simply, a data converter.

Does my submodule go in remote or convert?

Criteria Answer
My submodule doesn't work without internet. Remote
My submodule uses an HTTP interface, such as requests or urllib. Remote
My submodule can take in many datatypes, and returns many datatypes. Convert
My submodule uses a web service to convert data between types. Remote
Clone this wiki locally