🔩 Like builtins, but boltons. 250+ constructs, recipes, and snippets which extend (and rely on nothing but) the Python standard library. Nothing like Michael Bolton.
Go to file
Mahmoud Hashemi 9a6a375ada adding initial tox.ini (just 2.7 for now) 2015-04-09 21:34:24 -07:00
boltons fixing potential doctest failures due to dict key ordering 2015-04-09 21:33:49 -07:00
docs fix a link and update the docs nominal version (should automate this) 2015-04-09 14:34:58 -07:00
misc moving 'tests' directory out and under root as 'misc' (these are really more like utilities and examples) 2015-04-09 20:56:42 -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 double the typos, double the fun 2015-04-09 15:17:28 -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
requirements-test.txt adding initial tox.ini (just 2.7 for now) 2015-04-09 21:34:24 -07:00
setup.py bumping version for dev 2015-04-09 12:41:44 -07:00
tox.ini adding initial tox.ini (just 2.7 for now) 2015-04-09 21:34:24 -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:

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.