{
"info": {
"author": "Domnan Diretnan, Mmadu Manasseh",
"author_email": "diretnandomnan@gmail.com",
"bugtrack_url": null,
"classifiers": [
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3"
],
"description": "# Search Engine Parser\n\n\"If it is a search engine, then it can be parsed\" - Some random guy\n\n\n\n[](https://www.python.org/downloads/release/python-360/)\n[](https://badge.fury.io/py/search-engine-parser)\n[](https://travis-ci.com/bisoncorps/search-engine-parser)\n[](https://search-engine-parser.readthedocs.io/en/latest/?badge=latest)\n[](https://opensource.org/licenses/MIT)\n[](#contributors)\n\n\nPackage to query popular search engines and scrape for result titles, links and descriptions. Aims to scrape the widest range of search engines.\nView all [supported engines](https://github.com/bisoncorps/search-engine-parser/blob/master/docs/supported_engines.md)\n\n- [Search Engine Parser](#search-engine-parser)\n - [Popular Supported Engines](#popular-supported-engines)\n - [Installation](#installation)\n - [Development](#development)\n - [Code Documentation](#code-documentation)\n - [Running the tests](#running-the-tests)\n - [Usage](#usage)\n - [Code](#code)\n - [Command line](#command-line)\n - [Code of Conduct](#code-of-conduct)\n - [Contribution](#contribution)\n - [License (MIT)](#license-mit) \n## Popular Supported Engines\n\nSome of the popular search engines include:\n\n- Google\n- DuckDuckGo\n- GitHub\n- StackOverflow\n- Baidu\n- YouTube\n\nView all [supported engines](https://github.com/bisoncorps/search-engine-parser/blob/master/docs/supported_engines.md)\n\n## Installation\n\n```bash\n pip install search-engine-parser\n # Installs `pysearch` cli tool\n pip install \"search-engine-parser[cli]\"\n```\n\n## Development\n\nClone the repository\n\n```bash\n git clone git@github.com:bisoncorps/search-engine-parser.git\n```\n\nCreate virtual environment and install requirements\n\n```bash\n mkvirtualenv search_engine_parser\n pip install -r requirements/dev.txt\n```\n\n\n## Code Documentation\n\nFound on [Read the Docs](https://search-engine-parser.readthedocs.io/en/latest)\n\n## Running the tests\n\n```bash\n pytest\n```\n\n## Usage\n\n### Code\n\nQuery Results can be scraped from popular search engines as shown in the example snippet below\n\n```python\n from search_engine_parser import YahooSearch, GoogleSearch, BingSearch\n import pprint\n\n search_args = ('preaching to the choir', 1)\n gsearch = GoogleSearch()\n ysearch = YahooSearch()\n bsearch = BingSearch()\n gresults = gsearch.search(*search_args)\n yresults = ysearch.search(*search_args)\n bresults = bsearch.search(*search_args)\n a = {\n \"Google\": gresults,\n \"Yahoo\": yresults,\n \"Bing\": bresults}\n # pretty print the result from each engine\n for k, v in a.items():\n print(f\"-------------{k}------------\")\n pprint.pprint(v)\n\n # print first title from google search\n print(gresults[\"titles\"][0])\n # print 10th link from yahoo search\n print(yresults[\"links\"][9])\n # print 6th description from bing search\n print(bresults[\"descriptions\"][5])\n```\n\n### Command line\n\nSearch engine parser comes with a CLI tool known as `pysearch` e.g\n\n```bash\npysearch --engine bing search --query \"Preaching to the choir\" --type descriptions\n```\n\nResult\n\n```bash\n'Preaching to the choir' originated in the USA in the 1970s. It is a variant of the earlier 'preaching to the converted', which dates from England in the late 1800s and has the same meaning. Origin - the full story 'Preaching to the choir' (also sometimes spelled quire) is of US origin.\n```\n\n\n\nThere is a needed argument for the CLI i.e `-e Engine` followed by either of two subcommands in the CLI i.e `search` and `summary`\n\n```bash\n\nSearchEngineParser\n\npositional arguments:\n {search,summary} help for subcommands\n search search help\n summary summary help\n\noptional arguments:\n -h, --help show this help message and exit\n -e ENGINE, --engine ENGINE\n Engine to use for parsing the query e.g google, yahoo,\n bing, duckduckgo (default: google)\n```\n\n`summary` just shows the summary of each search engine added with descriptions on the return\n\n```bash\npysearch --engine google summary \n```\n\nFull arguments for the `search` subcommand shown below\n\n```bash\n\nusage: pysearch search [-h] -q QUERY [-p PAGE] [-t TYPE] [-r RANK]\n\noptional arguments:\n -h, --help show this help message and exit\n -q QUERY, --query QUERY\n Query string to search engine for\n -p PAGE, --page PAGE Page of the result to return details for (default: 1)\n -t TYPE, --type TYPE Type of detail to return i.e full, links, desciptions\n or titles (default: full)\n -r RANK, --rank RANK ID of Detail to return e.g 5 (default: 0)\n``` \n\n## Code of Conduct\n\nAll actions performed should adhere to the [code of conduct](https://github.com/bisoncorps/search-engine-parser/blob/master/CODE_OF_CONDUCT.md)\n\n\n## Contribution\n\nBefore making any contribution, please follow the [contribution guide](https://github.com/bisoncorps/search-engine-parser/blob/master/CONTRIBUTING.md)\n\n## License (MIT)\n\nThis project is opened under the [MIT 2.0 License](https://github.com/bisoncorps/search-engine-parser/blob/master/LICENSE) which allows very broad use for both academic and commercial purposes.\n\n## Contributors \u2728\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\n
![\"Ed](\"https://avatars0.githubusercontent.com/u/42586271?v=4\")
![\"Diretnan](\"https://avatars3.githubusercontent.com/u/23453888?v=4\")
![\"MeNsaaH\"/](\"https://avatars3.githubusercontent.com/u/24734308?v=4\")
![\"Aditya](\"https://avatars2.githubusercontent.com/u/25523604?v=4\")
![\"Avinash](\"https://avatars1.githubusercontent.com/u/27774996?v=4\")
![\"David](\"https://avatars3.githubusercontent.com/u/37768509?v=4\")