/query-server

Query Server Search Engines https://query-server.herokuapp.com

Primary LanguagePythonApache License 2.0Apache-2.0

Query-Server

Build Status Dependency Status Join the chat at https://gitter.im/fossasia/query-server codecov

The query server can be used to search a keyword/phrase on a search engine (Google, Yahoo, Bing, Ask, DuckDuckGo, Baidu, Exalead, Quora, Parsijoo, Dailymotion, Mojeek and Youtube) and get the results as json, xml or csv. The tool also stores the searched query string in a MongoDB database for analytical purposes.

Deploy to Docker Cloud Deploy Deploy on Scalingo Deploy to Bluemix

Table of Contents

Test Deployment

A test deployment of the project is available here: https://query-server.herokuapp.com

API

The API(s) provided by query-server are as follows:

GET /api/v1/search/<search-engine>?query=query&format=format

search-engine : [google, ask, bing, duckduckgo, yahoo, baidu, exalead, quora, youtube, parsijoo, mojeek, dailymotion]

query : query can be any string

format : [json, xml, csv]

A sample query : /api/v1/search/bing?query=fossasia&format=xml&num=10

Error Codes

404 Not Found : Incorrect Search Engine, Zero Response
400 Bad Request : query and/or format is not in the correct format
500 Internal Server Error : Server Error from Search Engine

Dependencies

Installation

  1. Local Installation

  2. Deployment on Heroku

  3. Deployment with Docker

Contribute

Found an issue? Post it in the issue tracker For pull requests please read Open Source Developer Guide and Best Practices at FOSSASIA

License

This project is currently licensed under the Apache License version 2.0. A copy of LICENSE should be present along with the source code. To obtain the software under a different license, please contact FOSSASIA.