Function reference
CLI helpers
Functionality that make our CLI apps more user-friendly, both in terms of appearance and behavior.
| pretty_print | Print with prettier formatting and highlighting. |
| print_if_verbose | Print with prettier formatting and highlighting. |
| run_without_tracebacks | Suppress traceback when running from CLI. |
| setup_cli | Setup the the Cyclopts app to use for the CLI. |
Example Data Packages
Class to access example data packages that we use for testing and demonstration purposes.
| Example | Available built-in example datapackage names. |
Functional programming
Functions that support a functional programming style.
| keep | Keep elements in items where fn returns True. |
| fmap | Apply fn to each element in items. |
| flat_fmap | Apply fn to each element in items and flatten one level. |
| pairwise_fmap | Apply fn to each pair of elements in items1 and items2. |
Reading Data Package properties
Functionality for reading properties from Data Packages.
| Address | A source parsed into an actual address. |
| parse_source | Parse the source of a Data Package into a formal Address. |
| read_properties | Read properties from a local or remote datapackage. |
| write_properties | Write properties to a local datapackage file and return the path. |