Relo: Recursive Document Content Search!¶
Relo is a simple, lightweight and extensible Search tool and framework for Python. It is distributed as a single script relopy and a library that can be used in other python apps.
- Content Search: Search files recursively search a folder, with all its containing files, for a certain string.
- Name Search: Search filenames recursively in a certain folder.
- Regex: Use Regular Expressions to extend and improve search.
- Plugins: Manage and use Plugins to implement support for additional doctypes.
Note
The Relo library doesn’t actually return any results yet it just prints them out. Things like this will be implemented before the final stable version.
Example: simple relo library
from relo import Relo
search = Relo(debug=False, hidden=False, content=True, recursive=True, directory='./', key='example')
search.list()
search.start()
Run this script or paste it into a python console, then watch the results come in.
Note
More control can be achieved by using the relo.core library.
Download and Install
You can use easy_install or pip as usual:
easy_install relo
pip install relo
Note
Still not fully tested!
Dependencies
Relo needs the argparse library for parsing arguments. Furthermore some of the plugins need libraries that help in loading and reading different kinds of files. As of now these libraries are:
- PyPdf: Needed for reading pages from pdf files
Note
The dependencies don’t install automatically when installing relo for now, some issues wrapping my head around setup.py. Will be fixed soon.
easy_install pypdf
pip install pypdf
When argparse doesn’t come with your python version installed.
easy_install argparse
pip install argparse
Usage Guide¶
Start here:
- Learn: how to use the relo library or the relopy script.
- Contribute: to the project.
- Contribute (DocType) and add additional doctypes.
Information Base¶
A database for tutorials, guides and other links that relate to relo.
Development and Contribution¶
These chapters are intended for developers interested in helping with the development process.
License¶
Code and documentation are available according to the BSD License:
Copyright (c) 2012, Cecil Woebker and individual contributors.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list
of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
Neither the name of the author nor the names of its contributors may be used
to endorse or promote products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.