UBelt documentation¶
UBelt is a “utility belt” of commonly needed utility and helper functions. It is a currated collection of utilities with functionality that falls into a mixture of the following categories:
- Timing
- Caching
- Hashing
- Command Line / Shell Interaction
- Cross-Platform Cache, Config, and Data Directories
- Symlinks
- Downloading Files
- Dictionary Histogram
- Find Duplicates
- Dictionary Manipulation
- AutoDict - Autovivification
- String-based imports
- Horizontal String Concatenation
- Standalone modules.
- progiter for Loop Progress
- timerit for Robust Timing and Benchmarking
- ordered-set for ordered set collections
For more detailed high level documentation see the README on github: https://github.com/Erotemic/ubelt.
The ubelt API is organized by submodules containing related functionality. Each submodule contains top level overview documentation, and each function contains a docstring with at least one example. Please see specific submodule documentation for more details.
- AutogenInit:
- mkinit ubelt -w # todo: get sphinx to ignore this
- ubelt
- ubelt package
- Submodules
- ubelt.orderedset module
- ubelt.progiter module
- ubelt.util_arg module
- ubelt.util_cache module
- ubelt.util_cmd module
- ubelt.util_colors module
- ubelt.util_const module
- ubelt.util_dict module
- ubelt.util_download module
- ubelt.util_format module
- ubelt.util_func module
- ubelt.util_hash module
- ubelt.util_import module
- ubelt.util_io module
- ubelt.util_links module
- ubelt.util_list module
- ubelt.util_memoize module
- ubelt.util_mixins module
- ubelt.util_path module
- ubelt.util_platform module
- ubelt.util_str module
- ubelt.util_stream module
- ubelt.util_time module
- Module contents
- Submodules
- ubelt package