Permalink
Fetching contributors…
Cannot retrieve contributors at this time
127 lines (98 sloc) 3.79 KB

boltons

boltons should be builtins.

release calver

Boltons is a set of pure-Python utilities in the same spirit as — and yet conspicuously missing from — the standard library, including:

And that's just a small selection. As of |today|, boltons is |b_type_count| types and |b_func_count| functions, spread across |b_mod_count| modules. See what's new by checking the CHANGELOG.

Installation and Integration

Boltons can be added to a project in a few ways. There's the obvious one:

pip install boltons

Then dozens of boltons are just an import away:

from boltons.cacheutils import LRU
lru_cache = LRU()
lru_cache['result'] = 'success'

Due to the nature of utilities, application developers might want to consider other integration options. See the :ref:`Integration <arch_integration>` section of the architecture document for more details.

Boltons is tested against Python 2.6, 2.7, 3.4, 3.5, and PyPy.

Third-party packages

The majority of boltons strive to be "good enough" for a wide range of basic uses, leaving advanced use cases to Python's myriad specialized 3rd-party libraries. In many cases the respective boltons module will describe 3rd-party alternatives worth investigating when use cases outgrow boltons. If you've found a natural "next-step" library worth mentioning, :ref:`consider filing an issue <Gaps>`!

Gaps

Found something missing in the standard library that should be in boltons? Found something missing in boltons? First, take a moment to read the very brief :doc:`architecture` statement to make sure the functionality would be a good fit.

Then, if you are very motivated, submit a Pull Request. Otherwise, submit a short feature request on the Issues page, and we will figure something out.

Section listing

.. toctree::
   :maxdepth: 2

   architecture
   cacheutils
   debugutils
   dictutils
   ecoutils
   fileutils
   formatutils
   funcutils
   gcutils
   ioutils
   iterutils
   jsonutils
   listutils
   mathutils
   mboxutils
   namedutils
   queueutils
   setutils
   socketutils
   statsutils
   strutils
   tableutils
   tbutils
   timeutils
   typeutils
   urlutils