dirwalker
=========
|PyPi Version| |Build Status| |Coverage Status| |License Badge|
`dirwalker <https://github.com/questrail/dirwalker>`__ is a Python
(2.6+/3.3+) package that walks multiple-level directories searching for
files with the given extensions.
Requirements
------------
- Python standard ``os`` module
Usage
-----
.. code:: python
import dirwalker
# Search with recursing subdirectories
dirwalker.find_filenames_with_extensions(
'/Users/me/dev/search_directory',
['txt', '.csv'])
# Search without recursing subdirectories
dirwalker.find_filenames_with_extensions(
'/Users/me/dev/search_directory',
['txt', '.csv'],
recurse=False)
Contributing
------------
`dirwalker <https://github.com/questrail/dirwalker>`__ is developed
using `Scott Chacon <http://scottchacon.com/about.html>`__'s `GitHub
Flow <http://scottchacon.com/2011/08/31/github-flow.html>`__. To
contribute, fork `dirwalker <https://github.com/questrail/dirwalker>`__,
create a feature branch, and then submit a pull request. `GitHub
Flow <http://scottchacon.com/2011/08/31/github-flow.html>`__ is
summarized as:
- Anything in the ``master`` branch is deployable
- To work on something new, create a descriptively named branch off of
``master`` (e.g., ``new-oauth2-scopes``)
- Commit to that branch locally and regularly push your work to the
same named branch on the server
- When you need feedback or help, or you think the branch is ready for
merging, open a `pull
request <https://help.github.com/articles/using-pull-requests>`__.
- After someone else has reviewed and signed off on the feature, you
can merge it into master.
- Once it is merged and pushed to ``master``, you can and *should*
deploy immediately.
License
=======
`dirwalker <https://github.com/questrail/dirwalker>`__ is released under
the MIT license. Please see the
`LICENSE.txt <https://github.com/questrail/dirwalker/blob/master/LICENSE.txt>`__
file for more information.
.. |PyPi Version| image:: http://img.shields.io/pypi/v/dirwalker.svg
:target: https://pypi.python.org/pypi/dirwalker/
.. |Build Status| image:: http://img.shields.io/travis/questrail/dirwalker/master.svg
:target: https://travis-ci.org/questrail/dirwalker
.. |Coverage Status| image:: https://img.shields.io/coveralls/questrail/dirwalker.svg
:target: https://coveralls.io/r/questrail/dirwalker
.. |License Badge| image:: http://img.shields.io/pypi/l/dirwalker.svg
:target: https://github.com/questrail/dirwalker/blob/master/LICENSE.txt
