🔩 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 1edb307882 always bugged me that priority queues was not capitalized the same way as other sections.		2016-04-27 23:08:30 -07:00
boltons	change BufferedSocket.recv to always return the rbuf data, even when it is less than the size requested. this way there is no chance of getting a socket error when there is data still in the read buffer, and when sockets are closed while calling recv, we know that the recv buffer is empty.	2016-04-27 22:37:47 -07:00
docs	always bugged me that priority queues was not capitalized the same way as other sections.	2016-04-27 23:08:30 -07:00
misc	more readable linkification for the CHANGELOG	2015-08-22 16:48:52 -07:00
tests	BufferedSocket is now threadsafe, no longer has a fileno, and there are ever more socketutils docs	2016-04-27 22:09:42 -07:00
.gitignore	ignoring tmp.py	2015-11-18 00:15:39 -08:00
.travis.yml	Improved the build matrix.	2016-02-29 13:09:15 +02:00
CHANGELOG.md	adding 16.1.1 and 16.2.0 to the CHANGELOG	2016-04-18 23:48:35 -07:00
LICENSE	adding license	2013-03-22 21:50:02 -07:00
README.md	quick README update, fixes #67	2016-03-12 23:53:53 -08:00
TODO.rst	couple dummy TODOs	2016-01-23 18:05:56 -08:00
requirements-rtd.txt	a bunch of docs cleanups	2015-09-24 11:51:21 -07:00
requirements-test.txt	Bumped pytest version.	2016-02-29 14:03:15 +02:00
setup.cfg	hynek's guide says setup.cfg should be [wheel]	2016-04-18 22:59:53 -07:00
setup.py	bumping version for 16.2.1dev development	2016-04-18 23:27:05 -07:00
tox.ini	have tox work off of the installed package instead of the source tree	2016-02-11 00:20:06 -08:00

README.md

Boltons

boltons should be builtins.

Boltons is a set of over 160 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
Recursive data structure iteration and merging, with iterutils.remap
Exponential backoff functionality, including jitter, through iterutils.backoff
A full-featured TracebackInfo type, for representing stack traces, in tbutils

Full and extensive docs are available on Read The Docs. See what's new by checking the CHANGELOG.

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

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, including vendorization of individual modules into a project. Boltons is pure-Python and has no dependencies. If the whole project is too big, each module is independent, and can be copied directly into a project. 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.