.. boltons documentation master file, created on Sat Mar 21 00:34:18 2015.


boltons
=======

*boltons should be builtins.*

**Boltons** is a set of utilities in the same spirit as the Python
builtins, and yet somehow not present in the standard library. A few
examples include:

* Atomic file saving, bolted on with fileutils
* A highly-optimized ``OrderedMultiDict``, in dictutils
* Two types of ``PriorityQueue``, in queueutils
* "Chunked" and "windowed" iteration, among many others, in iterutils
* A full-featured ``TracebackInfo`` type, for representing stack traces, in tbutils


Third-party packages
--------------------

The majority of boltons strive to be "good enough" for a wide range of
basic uses, leaving advanced use cases to specialized 3rd party
libraries. For example, no radical recommendations of NumPy inclusion
in the standard lib; the builtin number types and operations are
great! Built-in support for imaginary numbers for goodness sake!

Gaps
----

Found something missing in boltons? If you are very motivated, submit
a Pull Request. Otherwise, submit a feature request on the Issues
page, and we will figure something out.

Contents:

.. toctree::
   :maxdepth: 2

   strutils
   cacheutils
   debugutils
   dictutils
   fileutils
   formatutils
   funcutils
   gcutils
   iterutils
   jsonutils
   listutils
   mboxutils
   namedutils
   osutils
   queueutils
   setutils
   statsutils
   tableutils
   tbutils
   timeutils
   tzutils