Open Source Search Engine

A basic tool that finds documents based on simple logic-structured queries.

Getting started

To run this project you'll need Python 3.6.9 and Ubuntu 18.04. You'll need the next python packages

bitstring==3.1.6
wxPython==4.0.7.post2

The installer will try to download the above packages.

Installing

Clone the project:

$ git clone https://github.com/RazorBest/CDL-Open-Source-Search-Engine ossearch
$ cd ossearch

You can install Python from here: https://www.python.org/

Automatic installation

You can install the package with

$ sudo ./install.sh

Manual installation

If the script fails, you'll need to install the package manually. If you don't have pip3 install it like this:

$ sudo apt update
$ sudo apt install python3-pip

To install the package, use:

$ sudo -H pip3 install .

in the project directory.

After that, you'll need to install the dependecies.

You can install a package with pip like this:

$ pip3 install bitstring

to install the latest version, or like this:

$ pip3 install -Iv bitstring==3.1.6

to install a specific version.

To install wxPython, use:

$ pip3 install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-18.04/ wxPython

Or find the correpsonding wheel for your OS.

To see if wxPython installed succesfully, try this:

$ python3
Python 3.6.9 (default, Nov  7 2019, 10:44:02) 
[GCC 8.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import wx
>>> import wx.adv

If you don't get any errors, then you're ready.

Otherwise, try to install this:

$ sudo apt install libsdl1.2debian

How to use ossearch

To start the GUI, type "ossearch" in the terminal

$ ossearch

To start the shell, type

$ ossearch shell

Using the shell

First time, you'll need to load a directory(or more) in which ossearch will look for queries:

>>> load example_docs
>>> load path/to/direcyoty

Next time you run shell, the directories will be already loaded. So you have to load a directory just once, if you don't modify it. Ossearch will keep the loaded data in $HOME/.ossearch_data

To list the loaded directories use:

>>> list
example_docs
path/to/directory

To remove a loaded directory use:

>>> remove example_docs

To search using a query use "search [query]":

>>> search linux &&programming || (torvalds && linux)
Found:
    example_docs/doc03.txt
    example_docs/doc05.txt
    example_docs/doc11.txt

You can always type "help" to see the available commands

How construct a query

• For a one word search type that word. Eg.: "search linux" will find all the directories that contain the words "linux"
• Use the "&&" operator for stacking words: "search linux && torvalds" will search for directories that contain "linux" AND "torvalds"
• Use the "||" operator for choice: "search linux || programming" will find the directories that contain "linux" OR "programming"
• Use the "!" operator before an expression to negate it: "search !linux" will find all the directories that do not contain the word "linux"
• Use parantheses to combine expressions: ((linux || pc) && !(linus || torvalds)) && ((c || c++) && programming)

Running the tests

To run a "test_file.py" use:

python3 -m unittest tests/[test_file.py]

Documentation

Open Source Search Engine is a preselection project used for CDL. The problem description (in Romanian) is in CDL.pdf.