SearchTool

This tool is designed to help users retrieve relevant blog articles. It sits on top of existing search engines to further filter results to ensure relevance.

---

Getting started

To get started with this tool, download using the following command:

git clone https://github.com/zedrem/SearchTool

Prerequisites

Prior to running, you will need to have Python installed and access to a MongoDB implementation.

• Python - tested with version 3.6.1
• MongoDB - we have installed Mongo locally from MongoDB. However, you may also use a hosted solution such as Mongo Lab

Alternatively, you can use an online IDE like Cloud9 which comes with Python pre-installed. Instructions for setting up Mongo in Cloud9 can be found here

Installing requirements

Once you have Python and Mongo ready to go, you need to install the required Pip packages. These can be found in the requirements.txt file. You may install them manually using:

pip install -r requirements.txt

or run the provided MAKEFILE.

Set up the Custom Search API

This application runs on top of Google's Custom Search API (CSE). For instructions on how to set up CSE, consult the user guide in /docs

Updating the config file

Next, edit config.json, located in the config directory. Add the path to your database, your desired database name, API key and search engine ID.

{
	"db_url": "mongodb://127.0.0.1/",
	"db_client": "searchtool",
	"api_key": " api key ",
	"search_engine_id": " search engine id "
}

The setup file

Finally, run the setup file by navigating to the root directory in your terminal and using the command below:

python ./setup.py

This setup file tests the connection to your database, and then loads the example indicators and default config settings. More information on what these settings are can be found in the applications documentation (in the /docs directory). The application is now setup and ready to use.

---

Running the application

Read the user guide in /docs for a brief description of how to use this tool.

---

License

This application has been released under the MIT licese. More information can be found in the /LICENSE file.

---

Questions?

If you have any questions, please contact the projects author via the issues section, or by emailing: ashley.williams@pg.canterbury.ac.nz