"""
# SearchGooglePy `searchgpy`

SearchGooglePy is a simple (un-official) Google Search API under python.

## User-Manual

### `GoogleSearchEngine` SuperClass:

The SuperClass that initialize the module.

### `search_text` function:

The `search_text` function is the function that is used to search on Google's (`www.google.com`) web-engine.

@param `text` --- the text that you want to search on google.

### `search_img` function:

The `search_img` function has the role to search images on Google's (`www.google.com`) web-engine.

@param `text` --- The text that you want to search on google to display images.

### Quick Start:

A quick piece of code to get a quick start:

```py
import searchgpy

google_search_engine = searchgpy.GoogleSearchEngine()
google_search_engine.search_text('Hello World !')
```

This piece of code will search on google the sentence : `Hello World !`. Take a look at the `Table of Content` at https://www.github.com/Boubajoker/SearchGooglePy/blob/master/FEATURE_CONTRIBUTIONS.md or at https://boubajoker.github.io/SearchGooglePy/Link=Table_Of_Content for more content !

"""
class GoogleSearchEngine:
    def __init__(self) -> None: 
        """
        ### `GoogleSearchEngine` SuperClass:

        The SuperClass that initialize the module.
        """
        pass

    def search_text(self, text: str=None) -> None: 
        """
        ### `search_text` function:

        The `search_text` function has the role to search on Google's (`www.google.com`) web-engine.

        @param `text` --- The text that you want to search on google.
        """
        pass
    
    def search_img(self, text: str, download: str = False) -> None:
        """
        ### `search_img` function:

        The `search_img` function has the role to search images on Google's (`www.google.com`) web-engine.

        @param `text` --- The text that you want to search on google to display images.
        """
        pass
    
    def search_news(self, text: str) -> None:
        """
        ### `search_news` function:

        The `search_news` function has the role to search news on Google's (`www.google.com`) web-engine.
        
        @param `text` --- The text that you want to search on google to display news.
        """
        pass