ktrimey/sharksearch

A simple search API for SharkBook

sharksearch

\.          |\
   \`.___---~~  ~~~--_
   //~~----___  (_o_-~
  '           |/'    

A simple search API for SharkBook

sharksearch has two parts: a crawl, and a search API with a single endpoint /search, which takes a parameter query and an optional parameter category. Search performs case-sensitive substring match on names with query and exact match on categories with category.

You can test sharksearch out for yourself!

Installation:

It is a good idea to run sharksearch in a virtual environment. Set this up with the required dependencies with the following commands.

python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt

Running:

python3 crawl.py
flask run

To search through some sharks, clone the repository and run crawl.py. The crawl may take up to half an hour. (For testing purposes, the call to shark_crawl() in crawl.py may be given a max_sharks. By default, this is positive infinity.) After the crawl finishes (indicated by a log message, which also displays the number of sharks crawled), you may freely call flask run and use the web browser or otherwise to make HTTP requests to search.

For example:
http://127.0.0.1:5000/search?query=Breanna
http://127.0.0.1:5000/search?query=Breanna&category=Prionace%20glauca

Unit tests:

python3 -m unittest

Unit tests are implemented for crawl and search by faking, using the Python unittest framework. The unit test for search relies on crawl on the FakeSharkbook.

_{ASCII art by Tom Youderian}