Skip to content

Commit

Permalink
Minor modifications in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
bharadwajyarlagadda committed May 24, 2017
1 parent fc1823d commit 0f5a44b
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Command Line Interface tool which helps in finding a given text/pattern in a giv
Links
=====

Project: https://github.com/bharadwajyarlagadda/finder
Documentation: Wiki_
Pypi: https://pypi.python.org/pypi/finder
TravisCI: https://travis-ci.org/bharadwajyarlagadda/finder
- Project: https://github.com/bharadwajyarlagadda/finder
- Documentation: Wiki_
- Pypi: https://pypi.python.org/pypi/finder
- TravisCI: https://travis-ci.org/bharadwajyarlagadda/finder

Quickstart
==========
Expand All @@ -27,7 +27,6 @@ Install using pip:
Features
========


- Finds given text/pattern in the given file path(s).
- Iterates through all the non-executable files in a given directory path.
- Avoids all the non-readable files in a given directory path.
Expand Down Expand Up @@ -126,7 +125,9 @@ What does the API do?
1. The main entry point for our API is the ``api.find()`` method. You can pass in both file/directory paths and the pattern to be searched for.
2. If you provide a directory path, it will go ahead and do a ``os.walk`` and brings out all the files in that directory path.
3. While searching for the pattern,

* It avoids all the non-readable files:

* Audio files.
* Video files.
* Image files.
Expand Down Expand Up @@ -170,9 +171,11 @@ Data fields:
- ``path``: File path
- ``total_items``: Total items returned.
- ``items``: All the data items returned from the finder tool. The items comprise of:

* ``line_number``: Line number at which the pattern was found.
* ``line``: Actual line in which the pattern was found.
- ``error``: Errors from the finder tool if any.

* ``type``: Error type (Ex. PermissionError, OSError, etc.)
* ``message``: Error message from the finder tool.
* ``extra``: Any extra error message from the finder tool.
Expand Down

0 comments on commit 0f5a44b

Please sign in to comment.