dosho

A shinobi’s tool bag.

dosho is the native cab repository for shinobi (stimela-ninja, Stimela 3.0). A tool here is one of two shapes. A real binary is a YAML document, built into a Cab on demand; a Python-package tool with no standalone binary (CASA tasks are the running example) is a @shinobi.pystep-decorated function, producing a StepRef. Either way a cab is parameter configuration, so what matters is that it stays declarative rather than which format carries it: there is no dynamic_schema-style Python-execution step at cab-load time, no expression language, and no dtype coverage gaps – see Authoring tools in dosho for why this exists and how it’s structured.

Because a document is inert data, import dosho needs no shinobi at all. Reading the catalogue is a plain install; building a cab from a definition is the run extra:

$ pip install dosho          # the definitions: names, schemas, images
$ pip install "dosho[run]"   # ...plus stimela-ninja, to build and run them

Know the tool at write-time? Import it directly:

from dosho.cabs import wsclean
from dosho.cabs.casatasks import listobs

Only know the name at runtime? Use the string-keyed registry:

import dosho

wsclean = dosho.get("wsclean")

Or reach the same objects from shinobi’s own CLI, which discovers dosho through the shinobi.cabs entry point:

$ ninja cabs list
$ ninja cabs show wsclean

Every registered tool, with its resolved container image and full input/output schema, is in the cab catalog – generated from the live registry at build time.

Getting started

Concepts

Reference

Project

Indices