Cleaned up Docs and files to reflect cli installation usage

Author: MeNsaaH

.github/ISSUE_TEMPLATE/bug_report.md

@@ -26,6 +26,8 @@ If applicable, add screenshots to help explain your problem.
 **Desktop (please complete the following information):**
  - OS: [e.g. Windows]
  - Python Version [e.g. 3.6.5]
+ - Search-engine-parser version [e.g. 0.5.1]
+
 
 **Additional context**
 Add any other context about the problem here.

.travis.yml

@@ -8,7 +8,7 @@ python:
 
 # Command to install dependencies.
 install:
-  - pip install -r requirements-dev.txt
+  - pip install -r requirements/dev.txt
 
 # Build script (If successfully built - no errors)
 script:
@@ -19,14 +19,17 @@ script:
 after_success:
   - python setup.py --version
 
-deploy:
-  provider: pypi
-  user: "deven96"
-  password: $PYPI_PASSWORD
-  on:
-    branch: master
-  condition: $TRAVIS_TAG =~ ^v[0-9]+\.[0-9]+\.[0-9]+
-  skip_existing: true
+jobs:
+  include:
+    - stage: deploy
+      python: 3.7
+      deploy:
+        provider: pypi
+        user: "deven96"
+        password: $PYPI_PASSWORD
+        on:
+          tags: true
+        skip_existing: true
 
 after_deploy:
   - ./scripts/post_deploy_test.sh

MANIFEST.in

@@ -1,5 +1,6 @@
 include *.txt
+include requirements/*.txt
 include README.md
 recursive-include search_engine_parser *.py
 prune docs/ 
-prune scripts/
+prune scripts/

README.md

@@ -26,8 +26,7 @@ View all [supported engines](https://github.com/bisoncorps/search-engine-parser/
     - [Command line](#command-line)
   - [Code of Conduct](#code-of-conduct)
   - [Contribution](#contribution)
-  - [License (MIT)](#license-mit)
-
+  - [License (MIT)](#license-mit) 
 ## Popular Supported Engines
 
 Some of the popular search engines include:
@@ -45,6 +44,8 @@ View all [supported engines](https://github.com/bisoncorps/search-engine-parser/
 
 ```bash
     pip install search-engine-parser
+    # Installs `pysearch` cli  tool
+    pip install "search-engine-parser[cli]"
 ```
 
 ## Development
@@ -59,7 +60,7 @@ Create virtual environment and install requirements
 
 ```bash
     mkvirtualenv search_engine_parser
-    pip install -r requirements-dev.txt
+    pip install -r requirements/dev.txt
 ```
 
 

docs/source/search_engine_parser.core.engines.rst

@@ -12,6 +12,14 @@ search\_engine\_parser.core.engines.aol module
    :undoc-members:
    :show-inheritance:
 
+search\_engine\_parser.core.engines.ask module
+----------------------------------------------
+
+.. automodule:: search_engine_parser.core.engines.ask
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 search\_engine\_parser.core.engines.baidu module
 ------------------------------------------------
 
@@ -52,6 +60,14 @@ search\_engine\_parser.core.engines.google module
    :undoc-members:
    :show-inheritance:
 
+search\_engine\_parser.core.engines.myanimelist module
+------------------------------------------------------
+
+.. automodule:: search_engine_parser.core.engines.myanimelist
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 search\_engine\_parser.core.engines.stackoverflow module
 --------------------------------------------------------
 

docs/source/search_engine_parser.tests.rst

@@ -4,6 +4,14 @@ search\_engine\_parser.tests package
 Submodules
 ----------
 
+search\_engine\_parser.tests.base module
+----------------------------------------
+
+.. automodule:: search_engine_parser.tests.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 search\_engine\_parser.tests.test\_search module
 ------------------------------------------------
 

scripts/post_deploy_test.sh

@@ -6,13 +6,21 @@ echo "${VERSION}"
 
 # install python package
 pip install search-engine-parser=="${VERSION}"
+python -c "import search_engine_parser"
+
+pip uninstall search-engine-parser 
+
+pip install search-engine-parser[pysearch]=="${VERSION}"
 
 # run the cli version to get a result
 python -m search_engine_parser.core.cli --engine bing search --query "Preaching to the choir" --type descriptions
 
+# run cli with pysearch
+pysearch -e youtube search -q "NoCopyrightSounds"
+
 if [ $? -eq 0 ]; then
     echo "Package works as expected"
 else
     echo "CLI handler of the package failed to execute"
     exit 1
-fi
+fi

search_engine_parser/__init__.py

@@ -26,4 +26,4 @@
 from search_engine_parser.core import *
 
 name = "search-engine-parser"  #pylint: disable=invalid-name
-__version__ = "0.5.2"
+__version__ = "0.5.3.post2"

search_engine_parser/tests/test_search.py

@@ -38,6 +38,11 @@ class BingEngineTest(EngineTestBase, EngineTests):
 class AolSearchTest(EngineTestBase, EngineTests):
     engine_class = AolSearch
 
+    def test_returned_results(self):
+        self.assertTrue(len(self.results['titles']) >= 9)
+        self.assertTrue(len(self.results['links']) >= 9)
+        self.assertTrue(len(self.results['descriptions']) >= 9)
+
 
 class DuckDuckGoSearchTest(EngineTestBase, EngineTests):
     engine_class = DuckDuckGoSearch
@@ -65,9 +70,9 @@ class BaiduSearchTest(EngineTestBase, EngineTests):
     engine_class = BaiduSearch
 
     def test_returned_results(self):
-        self.assertTrue(len(self.results['titles']) >= 9)
-        self.assertTrue(len(self.results['links']) >= 9)
-        self.assertTrue(len(self.results['descriptions']) >= 9)
+        self.assertTrue(len(self.results['titles']) >= 8)
+        self.assertTrue(len(self.results['links']) >= 8)
+        self.assertTrue(len(self.results['descriptions']) >= 8)
 
 
 class GithubSearchTest(EngineTestBase, EngineTests):

setup.py

@@ -1,16 +1,16 @@
 import re
 import setuptools
 
-REQUIREMENTS = 'requirements/main.txt'
-CLI_REQUIREMENTS = 'requirements/cli.txt'
-
 REQUIRED_PYTHON = (3, 5)
 
-requires = [line.strip('\n') for line in open(REQUIREMENTS).readlines()]
-requires_cli = [line.strip('\n') for line in open(CLI_REQUIREMENTS).readlines()]
+# Load requirements
+REQUIREMENTS = 'requirements/main.txt'
+CLI_REQUIREMENTS = 'requirements/cli.txt'
+REQUIREMENTS = [line.strip('\n') for line in open(REQUIREMENTS).readlines()]
+CLI_REQUIREMENTS = [line.strip('\n') for line in open(CLI_REQUIREMENTS).readlines()]
 
 with open("README.md", "r") as fh:
-    long_description = fh.read()
+    LONG_DESCRIPTION = fh.read()
 
 # Trying to load version directly from `search-engine-parser` module attempts
 # to load __init__.py which will try to load other libraries not yet installed
@@ -25,12 +25,12 @@
     description="scrapes search engine pages for query titles, descriptions and links",
     url="https://github.com/bisoncorps/search-engine-parser",
     project_urls={
-        "documentation":"https://search-engine-parser.readthedocs.io/en/latest",
-        "source": "https://github.com/bisoncorps/search-engine-parser",
+        "Documentation":"https://search-engine-parser.readthedocs.io/en/latest",
+        "Source": "https://github.com/bisoncorps/search-engine-parser",
     },
     packages=setuptools.find_packages(),
-    install_requires=requires,
-    long_description=long_description,
+    install_requires=REQUIREMENTS,
+    long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",
     license="MIT",
     keywords='\
@@ -54,10 +54,11 @@
     ],
     package_data={
         '': ['*.*'],
+        'requirements': ['*.*'],
     },
     include_package_data=True,
     extras_require={
-        'cli': requires_cli
+        'cli': CLI_REQUIREMENTS
     },
     python_requires='>={}.{}'.format(*REQUIRED_PYTHON),
 )