🔩 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 0c362c5cee debugging RTD issue #1692		2015-09-24 12:14:34 -07:00
boltons	a bunch of docs cleanups	2015-09-24 11:51:21 -07:00
docs	debugging RTD issue #1692	2015-09-24 12:14:34 -07:00
misc	more readable linkification for the CHANGELOG	2015-08-22 16:48:52 -07:00
tests	adding prepopulation test case for remap	2015-09-21 02:39:10 -07:00
.gitignore	Ignore Vim swap files	2015-05-01 09:07:21 +08:00
.travis.yml	Properly parse tracebacks with missing source. Resolves #30	2015-04-19 00:21:19 -07:00
CHANGELOG.md	update CHANGELOG to reflect 15.1.0 release	2015-09-23 23:42:22 -07:00
LICENSE	adding license	2013-03-22 21:50:02 -07:00
README.md	linking the changelog from the README and the docs	2015-08-23 05:52:51 -07:00
TODO.rst	a tested and working implementation of dictutils.OrderedMutliDict.sortedvalues()	2015-08-27 01:09:02 -07:00
requirements-rtd.txt	a bunch of docs cleanups	2015-09-24 11:51:21 -07:00
requirements-test.txt	removing six dep in requirements-test.txt	2015-04-11 02:44:24 -07:00
setup.py	bumping version for 15.1.1 development	2015-09-23 01:35:26 -07:00
tox.ini	adding py26 to tox	2015-05-18 00:15:16 -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 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

Boltons is tested against Python 2.6, 2.7, 3.4, and PyPy. Full and extensive docs are available on Read The Docs. See what's new by checking the CHANGELOG.

Installation

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

    pip install boltons

Then, thanks to PyPI, 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.