Skip to content

Latest commit

 

History

History
66 lines (53 loc) · 2.39 KB

README.md

File metadata and controls

66 lines (53 loc) · 2.39 KB

dirwalker

PyPi Version Build Status Coverage Status License Badge

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

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 is developed using Scott Chacon's GitHub Flow. To contribute, fork dirwalker, create a feature branch, and then submit a pull request. GitHub Flow 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.
  • 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 is released under the MIT license. Please see the LICENSE.txt file for more information.