dosho

A shinobi’s tool bag.

dosho is the native cab repository for shinobi (stimela-ninja, Stimela 3.0). Every tool is authored directly in Python instead of a YAML dialect – a Cab for a real binary, or a @shinobi.pystep-produced StepRef for a Python-package tool with no standalone binary (CASA tasks are the running example). There is no dynamic_schema-style Python-execution step at cab-load time, and no dtype coverage gaps – see Authoring tools in dosho for why this exists and how it’s structured.

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

import dosho

wsclean = dosho.get("wsclean")

$ ninja cabs list
$ ninja cabs show wsclean

Getting started

• Installation
  • Requirements
  • From GitHub
  • For development
• Quickstart
  • Look up a tool
  • Use it in a recipe
  • Inspect a tool from the command line
  • Where to next

Concepts

• Authoring tools in dosho
  • Why a Python cab format, not cult-cargo’s YAML?
  • Two shapes: Cab and pystep
  • Defining a Cab
  • Dynamic per-instance parameter families
  • Dynamic output paths
  • Container images
  • Layout: single-command vs. multi-command tools
  • Two lookup interfaces, one set of objects

Reference

• API reference
  • Top-level package
  • Registry (string-keyed lookup)
  • Cab-authoring helper
  • Tools
  • Shinobi schema types

Project

• Contributing
  • Contributing to dosho

Indices

• Index

• Module Index

• Search Page