Source

jaraco.util / README

Full commit
.. -*- restructuredtext -*-

jaraco.util
===========

.. contents::

Status and License
------------------

``jaraco.util`` provides miscellaneous utility functions used across
projects developed by the author.

``jaraco.util`` is written by Jason R. Coombs.  It is licensed under an
`MIT-style permissive license
<http://www.opensource.org/licenses/mit-license.php>`_.

You can install it with ``easy_install jaraco.util``, or from the
`mercurial repository
<http://bitbucket.org/jaraco/jaraco.util/get/tip.zip#egg=jaraco.util-dev>`_ with
``easy_install jaraco.util==dev``.

Changes
-------

3.7
~~~

* Added jaraco.util.dictlib.DictAdapter
* Added jaraco.util.dictlib.ItemsAsAttributes

3.6
~~~

* Added jaraco.util.editor (with EditableFile for editing strings in a
  subprocess editor).

3.5.1
~~~~~

* Removed apng from .image so the package now installs on Python 2.5
  with only one error.

3.5
~~~

* Added `jaraco.util.iter_.window` and `.nwise`
* Added `jaraco.util.filesystem.ensure_dir_exists` decorator
* Added `jaraco.util.iter_.Peekable` iterator wrapper
* Moved `jaraco.util.package` to `jaraco.develop` project

3.4
~~~

* Adding jaraco.util.concurrency

3.3
~~~

* Added prorating calculator and console script calc-prorate.
* Added `iter_.peek`
* Renamed QuickTimer to Stopwatch - modified to PEP8 specs
* Adding jaraco.filesystem.DirectoryStack
* Added `iter_.one` and `iter_.first`

3.2
~~~

* Removed release module and moved its function to the package module.

3.1
~~~~~

* Added skip_first to `jaraco.util.iter_`
* Moved rss module to `jaraco.net` package.
* Bug fixes in `iter_.flatten`.
* Restored Python 2 compatibility and implemented 2to3 for deployment.
  `jaraco.util` is now easy_installable on Python 2 and Python 3.

3.0.1
~~~~~

* More Python 3 changes.
* Fixes bug in `jaraco.util.meta.LeafClassesMeta`.
* Added jaraco.util.string.local_format

3.0
~~~

This version includes many backwards-incompatible changes.

* May require Python 2.6
* Removed powerball module
* Refactored RangeMap: RangeValueUndefined, RangeItem/First/Last moved into RangeMap class. RangeValueUndefined, RangeItemFirst, and RangeItemLast are now instances, not classes. Renamed to UndefinedValue, Item, FirstItem, LastItem.
* Renamed DictMap function to dict_map
* Renamed `iter_.evalAll` to `iter_.consume` and evalN to consume_n
* More Python 3 improvements
* Added rss feed handler (this perhaps this belongs in jaraco.net, and may be moved in the future)
* Renamed ciString to jaraco.util.string.FoldedCase and added support for sorting case-insensitive strings
* Added some useful iterator tools.
* Added bitutil, based on some functions in jaraco.input
* Added some rich comparison mixins in `jaraco.util.cmp_`
* Added PasswordGenerator from jaraco.site
* Added logging module for commonly-used logging patterns

2.3
~~~

* Minor fixes, primarily to deployment techniques
* Mostly Python 3 compatible.
* Final release before major refactoring.

2.2
~~~

* First release with documentation.

2.1
~~~

* Added package release script.
* Added RelativePath, a class for manipulating file system paths
* Added trim function

2.0
~~~

* First release with no dependencies.

1.0
~~~

* Initial release