Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fossasia/query-server

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

Last synced: about 6 hours ago
JSON representation

Query Server Search Engines

Host: GitHub
URL: https://github.com/fossasia/query-server
Owner: fossasia
License: apache-2.0
Created: 2016-11-25T20:24:01.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2021-01-23T16:48:56.000Z (over 3 years ago)
Last Synced: 2024-09-22T01:34:40.148Z (3 days ago)
Language: Python
Homepage:
Size: 5.08 MB
Stars: 1,657
Watchers: 14
Forks: 264
Open Issues: 27
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-scalingo - Github

README

        # Query-Server

[![Build Status](https://travis-ci.org/fossasia/query-server.svg?branch=master)](https://travis-ci.org/fossasia/query-server)

[![Dependency Status](https://david-dm.org/fossasia/query-server.svg)](https://david-dm.org/ossasia/query-server)

[![Join the chat at https://gitter.im/fossasia/query-server](https://badges.gitter.im/fossasia/query-server.svg)](https://gitter.im/fossasia/query-server?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![codecov](https://codecov.io/gh/fossasia/query-server/branch/master/graph/badge.svg)](https://codecov.io/gh/fossasia/query-server)

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](https://files.cloud.docker.com/images/deploy-to-dockercloud.svg)](https://cloud.docker.com/stack/deploy/?repo=https://github.com/fossasia/query-server) [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/fossasia/query-server) [![Deploy on Scalingo](https://cdn.scalingo.com/deploy/button.svg)](https://my.scalingo.com/deploy?source=https://github.com/fossasia/query-server#master) [![Deploy to Bluemix](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https://github.com/fossasia/query-server&branch=master)

## Table of Contents

- [Test Deployment](#test-deployment)

- [API](#api)

- [Error Codes](#error-codes)

- [Dependencies](#dependencies)

- [Installation](#installation)

- [Contribute](#contribute)

## 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/?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

* [MongoDB](https://www.mongodb.com)

* [Python 2.7](https://python.org)

    * [BeautifulSoup4](https://www.crummy.com/software/BeautifulSoup/bs4/doc)

    * [dicttoxml](https://github.com/quandyfactory/dicttoxml)

    * [Flask](http://flask.pocoo.org)

    * [pymongo](https://api.mongodb.com/python/current)

    * [requests](http://docs.python-requests.org)

* [Node.js](https://nodejs.org/en)

    * [bower.io](https://bower.io)

## Installation

1. [Local Installation](/docs/installation/local.md)

2. [Deployment on Heroku](/docs/installation/heroku.md)

3. [Deployment with Docker](/docs/installation/docker.md)

## Contribute

Found an issue? Post it in the [issue tracker](https://github.com/fossasia/query-server/issues)  For pull requests please read [Open Source Developer Guide and Best Practices at FOSSASIA](https://blog.fossasia.org/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](http://blog.fossasia.org/contact/).