Metadata-Version: 2.0
Name: fsfind
Version: 0.1.dev0
Summary: Efficiently find files and directories
Home-page: https://github.com/moloney/fsfind
Author: Brendan Moloney
Author-email: moloney.brendan@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy


.. -*- rest -*-
.. vim:syntax=rest

======
fsfind
======

This package provides similar functionality to the Unix `find` command, but 
in a pythonic fashion. A `FsFinder` object encapsulates a number of 
rules that define how to traverse a directory structure and try to match the 
paths along the way. The `FsFinder.walk` method takes one or more root paths 
to start from and generates a `MatchResult` object for any path it encounters 
that match its rules.

The package is built upon the `scandir` package which provides effiecient 
directroy listing and the ability to avoid unneeded 'stat' calls on the paths 
being generated.


Running Tests
-------------

You can run the tests with:

$ python setup.py test

Or if you already have the *nose* package installed you can use the 
*nosetests* command in the top level directory:

$ nosetests

Installing
----------

You can install the *.zip* or *.tar.gz* package with the *easy_install* 
or *pip* commands.

Or you can uncompress the package and in the top level directory run:

$ python setup.py install


