🔩 Like builtins, but boltons. 250+ constructs, recipes, and snippets which extend (and rely on nothing but) the Python standard library. Nothing like Michael Bolton.

cache data-science data-structures file json python queue recursive standard-library starred-mahmoud-repo starred-repo statistics utilities

Go to file

Mahmoud Hashemi 9bcd8d5969 bumping version for release		2015-04-09 12:40:13 -07:00
boltons	clear out __init__, as planned	2015-04-09 01:00:01 -07:00
docs	tweak links in index.rst	2015-04-09 00:36:48 -07:00
.gitignore	adding initial docs	2015-03-21 17:12:50 -07:00
LICENSE	adding license	2013-03-22 21:50:02 -07:00
README.md	make README highly linkful	2015-04-09 00:58:20 -07:00
TODO.rst	add gc.get_all() for getting all instances of a type, update TODO	2015-03-07 18:02:23 -08:00
requirements-rtd.txt	try one more thing to get RTD's sphinx version to play nice with napoleon and themes	2015-03-31 01:15:19 -07:00
setup.py	bumping version for release	2015-04-09 12:40:13 -07:00

README.md

Boltons

boltons should be builtins.

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

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

Full and extensive docs are available on Read The Docs.

Installation

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
    my_cache = LRU()

However, due to the nature of utilities, application developers might want to consider other options. Boltons is pure-Python and has no dependencies. See the Integration section of the docs for more details.

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, see the next section!

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 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.