Walkdir

~~~~~~~~~~~~~~~~~~

* Include release date in release history

~~~~~~~~~~~~~~~~

* *SEMANTIC CHANGE*: to implement some of the fixes noted below, the
``all_paths`` iterator has been updated to emit paths in the following
order for each directory produced by the underling iterator:

* given directory if it appears to be a new root directory (i.e. it is
not a subdirectory of the current root directory)
* files in the given directory
* subdirectories of the given directory

Previously, directories were only emitted when walked by the underling
iterator, which resulted in paths being missed in some cases.

* Thanks go to Aviv Palivoda for being the driving force behind this release,
especially in addressing a variety of issues in the way directory filtering
and symlinks to directories are handled.

* Issue 12: a new API, ``all_dir_paths`` has been added which, in addition to
the directories visited by the underlying walk, also emits:

* symlinks to directories when ``followlinks`` is disabled in the
underlying iterator
* subdirectories of leaf directories when the directory tree depth of
the underlying iterator has been limited (for example, with the
``limit_depth`` filter)

* Issue 3: ``all_paths`` now correctly reports symlinks to directories as
directory paths, even when ``followlinks`` is disabled in the underlying
iterator (fix contributed by Aviv Palivoda)

* Issue 4: ``all_paths`` now correctly reports subdirectories at the maximum
depth when the ``limit_depth`` filter is used to trim nested subdirectories
(fix contributed by Aviv Palivoda)

* Issue 6: ``min_depth``, ``all_paths``, ``dir_paths``, and ``file_paths``
all now work correctly with ``os.fwalk`` and other underlying iterators
that produce a sequence with more than 3 elements for each directory
(fix contributed by Aviv Palivoda)

* Issue 7: all filters now explicitly indicate in their documentation whether
or not they support being used with bottom-up traversal of the underlying
directory hierarchy

* A temporary generated filesystem is now used to test symlink loop handling
and other behaviours that require a real filesystem (patch contributed by
Aviv Palivoda)

* The correct error message is now emitted when an invalid maximum depth is
passed to ``limit_depth`` on Python 2.6 (fix contributed by Aviv Palivoda)

* The correct error message is now emitted when an invalid minimum depth is
passed to ``min_depth`` on Python 2.6 (fix contributed by Aviv Palivoda)

* development has migrated from BitBucket to GitHub

~~~~~~~~~~~~~~~~~~

* (BitBucket) Issue 7: filter functions now pass the tuples created by underlying
iterators through without modification, using indexing rather than
tuple unpacking to access values of interest. This means WalkDir now
supports any underlying iterable that produces items where ``x[0], x[1],
x[2]`` refers to ``dirpath, subdirs, files``. For example, if the
the iterable produces ``collections.namedtuple`` instances, those will be
passed through to the output of a filtered walk.

~~~~~~~~~~~~~~~~~~

* Add MANIFEST.in so PyPI package contains all relevant files

~~~~~~~~~~~~~~~~

* (BitBucket) Issue 6: Added a ``min_depth`` option to ``filtered_walk`` and a new
``min_depth`` filter function to make it easier to produce a list of full
subdirectory paths
* (BitBucket) Issue 5: Renamed path iteration convenience APIs:
* ``iter_paths`` -> ``all_paths``
* ``iter_dir_paths`` -> ``dir_paths``
* ``iter_file_paths`` -> ``file_paths``
* Moved version number to a VERSION.txt file (read by both docs and setup.py)
* Added NEWS.rst (and incorporated into documentation)

~~~~~~~~~~~~~~~~

* Initial release