Skip to main content

Look for files and text inside files

Project description


PyFinder allows you either to find files in the file-system or some text inside files. It provides a library (the file) and a script called pyfinder, that can be executed from the command line.

Supported Python versions

PyFinder requires Python version 3.3 or above.

Installation instructions

PyFinder is only released as a source distribution. Installing by pip is the simplest and preferred way on all systems:

$ pip install pyfinder

Otherwise download the source tarball from, uncompress it, enter the pyfinder-x.y directory and then run the install command:

$ python install

How to use PyFinder

To use the pyfinder module just import it and call its functions. Here is some examples:

>>> import os
>>> import email
>>> import pyfinder
>>> for file in pyfinder.file_finder('', os.path.dirname(email.__file__)):
...     print(os.path.basename(file))
>>> for match in pyfinder.file_inspector(pyfinder.__file__, 'def file_*'):
...     print(match, end='')
def file_finder(pattern: str, top_dir: str=os.curdir, recursive: bool=False):
def file_inspector(file_name: str, pattern: str):

For more information about the module usage look at its documentation (pyfinder.__doc__). There is also a pyfinder script that allows you to easily find files and text inside files from the command line. For information about the script usage look at the output of pyfinder -h.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyfinder-0.2.tar.gz (2.7 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page