Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A tool for searching the entire web with the Google technology

Project description

==================================================

A tool for searching the entire web with the Google technology

|PyPi| |ZIP| |GIT|

Index
-----

1. `Introduction <https://github.com/Javinator9889/pyGle#1-introduction>`__
2. `Purpose <https://github.com/Javinator9889/pyGle#2-purpose>`__
3. `Installation <https://github.com/Javinator9889/pyGle#3-installation>`__
4. `Instructions <https://github.com/Javinator9889/pyGle#4-instructions>`__
5. `Contribute <https://github.com/Javinator9889/pyGle#5-contribute>`__
6. `License <https://github.com/Javinator9889/pyGle#6-license>`__

1. Introduction
---------------

`pyGle <https://github.com/Javinator9889/pyGle>`__ aims to be a *very powerful* tool for just **searching the entire web** by using the *Google* technology, without **any limitations** (or almost no one).

Just with a *few lines* of code you will be able to:

- Perform a *normal search* on Google 馃攷
- Look at *Google Images* for obtaining all the information you need about a pic 馃寘
- Search *the latest news* and also **a lot of articles** on *Google News* 馃摪
- Filter and obtain *patents* by using *Google Patents* 馃摑
- Have a look at hundreds of *different products* at *Google Shops* 馃洅
- Look for *books*, *magazines* and more at *Google Books* 馃摌
- Videos, videos and more videos at *Google Videos* 馃帴

As the speed is a crucial factor, I developed this library in order to be the fastest one for each possible situation.

With every search, a little log is included at the end of the result with the **available stats** for the web scrapping. After some test, I noticed that using `requests <https://github.com/requests/requests>`__ **slow down** the overall speed. For that reason is why you can see the lib performs all *Internet access* by using `urllib <https://docs.python.org/3/library/urllib.html>`__, which has two advantages:

1. Is included with **all Python installations**, so it is a less library to install.
2. The requests overall time has been reduced at almost **70%**: with *requests*, it took about **3~4 seconds**. With *urllib*, that time now becomes about **~1 second** or less.

With the motivation of the said before, when performing a *research*, the lib **instantly** returns the object that you will use in the future for gathering the results. That object is also known as a **Future** (*you can read more information right here* `馃憠 Python Concurrent Futures <https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future>`__), whose functionality is the following:

- You want to *do a research* at Google.
- As explained before, it needs about **~1 second** to complete, so it is a lot of time for you to do *other things* that do not depend on the result of your search.
- So when you ask `pyGle <https://github.com/Javinator9889/pyGle>`__ to scrap the web with Google, it returns a **Future** object. At the first moment, it does have **nothing**, but when `pyGle <https://github.com/Javinator9889/pyGle>`__ ends its work, the Future object will contain all the data.
- `pyGle <https://github.com/Javinator9889/pyGle>`__ automatically detects the *number of processors* of your system so it can speed-up all the process.

2. Purpose
----------

Searching the web with Google *is very easy* from a web browser such as Chrome or Firefox, but sometimes we need that **information** to be available for a program that we are developing or similar. Or just we need to *transform and work with that info*.

For that situation, `pyGle <https://github.com/Javinator9889/pyGle>`__ is the real solution. By using the powerful `Python lists <https://docs.python.org/3/tutorial/datastructures.html#more-on-lists>`__ and also `Python dictionaries <https://docs.python.org/3/tutorial/datastructures.html#dictionaries>`__, `pyGle <https://github.com/Javinator9889/pyGle>`__ will give you all what you need. Let me exemplify you with a simple search of the term *"test"*:

1. Here is the simplicity of `pyGle <https://github.com/Javinator9889/pyGle>`__ in code for achieving that:

.. code:: python

from pprint import pprint # Not necessary but for a beautiful print
from pyGle import PyGle

pSearch = PyGle(query="test")
ft = pSearch.doSearch() # A Future object
pprint(ft.result())

2. And now, when the Future is done, here is the result:

.. code:: python

[ { 'cached_version': 'http://webcache.googleusercontent.com/search?q=cache:jNPwduM3zRgJ:www.eljueves.es/news/test-que-meme-eres_2448+&cd=1&hl=es&ct=clnk&gl=es',
'date': '30 may. 2018',
'description': '30 may. 2018 -Olv铆dalas Lo mejor para definir tu '
'personalidad son los memes. Descubre cu谩l es el tuyo '
'con este rigurosotestavalado por la Universidad...',
'link': 'http://www.eljueves.es/news/test-que-meme-eres_2448',
'title': 'TEST: 驴Qu茅 meme eres? - El Jueves'},
{ 'cached_version': 'https://webcache.googleusercontent.com/search?q=cache:nbx31tovq8UJ:https://www.enfemenino.com/psico/tests-ssc17.html+&cd=2&hl=es&ct=clnk&gl=es',
'date': 'unavailable',
'description': 'Tests-Testde personalidad de inteligencia de '
'belleza... todo tipo detestque te pueden ayudar a '
'tomar decisiones o simplemente aclararte las ideas.',
'link': 'https://www.enfemenino.com/psico/tests-ssc17.html',
'title': 'Tests - Tests de personalidad, inteligencia, moda, belleza, '
'| enfemenino'},
{ 'cached_version': 'https://webcache.googleusercontent.com/search?q=cache:PQFS2G6QNgAJ:https://www.muyinteresante.es/tests+&cd=3&hl=es&ct=clnk&gl=es',
'date': 'unavailable',
'description': 'TestsMuyInteresante.es. Mide tu ingenio y lo que sabes '
'de forma divertida y amena.',
'link': 'https://www.muyinteresante.es/tests',
'title': 'Tests inteligentes y curiosos en Muy Interesante Espa帽a'},
{ 'cached_version': 'https://webcache.googleusercontent.com/search?q=cache:iQ_U_r5BkKkJ:https://www.testdevelocidad.es/+&cd=4&hl=es&ct=clnk&gl=es',
'date': 'unavailable',
'description': 'Testde velocidad para medir la calidad de tu acceso a '
'Internet con ADSL o fibra 贸ptica . Comprueba la '
'velocidad real de tu conexi贸n.',
'link': 'https://www.testdevelocidad.es/',
'title': 'Test de velocidad : Mide tu ADSL o fibra con el SpeedTest de '
'www ...'},
{ 'cached_version': 'https://webcache.googleusercontent.com/search?q=cache:m6vzOP8qmEsJ:https://www.arealme.com/mental/es/+&cd=5&hl=es&ct=clnk&gl=es',
'date': 'unavailable',
'description': 'Testde edad mental. cual es tu edad mental. Estetestes '
'de origen japon茅s y se llama . Por favor s茅 sincero al '
'responder a las preguntas.',
'link': 'https://www.arealme.com/mental/es/',
'title': 'Test de edad mental (cual es tu edad mental) - A Real Me'},
{ 'cached_version': 'https://webcache.googleusercontent.com/search?q=cache:gU4XOSuOIR0J:https://www.clara.es/temas/test+&cd=6&hl=es&ct=clnk&gl=es',
'date': 'unavailable',
'description': 'Haz nuestrostesty descubre cu谩l es la mejor dieta para '
'adelgazar los mejores tratamientos est茅ticos y de '
'belleza los alimentos que mejor te sientan.',
'link': 'https://www.clara.es/temas/test',
'title': 'Test dieta, belleza, salud, alimentaci贸n, nutrici贸n, '
'psicolog铆a, moda鈥'},
{ 'cached_version': 'https://webcache.googleusercontent.com/search?q=cache:2C5cLoSzSKoJ:https://testdivertidos.es/+&cd=7&hl=es&ct=clnk&gl=es',
'date': 'unavailable',
'description': 'TestDivertidos.es - Lostestsgratis m谩s divertidos de '
'internet:testde inteligencia personalidad psicol贸gicos '
'de amor para ni帽os...',
'link': 'https://testdivertidos.es/',
'title': 'Test Divertidos | Los tests m谩s divertidos de la web'},
{ 'cached_version': 'https://webcache.googleusercontent.com/search?q=cache:hBp-w20VAWEJ:https://www.psicoactiva.com/tests/personalidad/test-personalidad-5factores.htm+&cd=8&hl=es&ct=clnk&gl=es',
'date': 'unavailable',
'description': 'Testgratis que eval煤a la Personalidad a partir de sus '
'cinco Dimensiones llamadas Los Cinco Grandes.',
'link': 'https://www.psicoactiva.com/tests/personalidad/test-personalidad-5factores.htm',
'title': 'PsicoActiva.com: Test de personalidad de cinco factores.'},
{ 'cached_version': 'https://webcache.googleusercontent.com/search?q=cache:3_8PsvuNwh0J:https://www.nationalgeographic.com.es/temas/tests-ng+&cd=9&hl=es&ct=clnk&gl=es',
'date': 'unavailable',
'description': 'Pon a prueba tus conocimientos con losTESTde National '
'Geographic sobre historia naturaleza pa铆ses ciencia '
'personajes hist贸ricos ciudades...',
'link': 'https://www.nationalgeographic.com.es/temas/tests-ng',
'title': 'Los mejores TEST de National Geographic'},
{ 'cached_version': 'http://webcache.googleusercontent.com/search?q=cache:-7iUEjuLNkMJ:www.movistar.es/particulares/test-de-velocidad/+&cd=10&hl=es&ct=clnk&gl=es',
'date': 'unavailable',
'description': 'Comprueba la velocidad de tu conexi贸n a Internet con '
'eltestde velocidad que usan los instaladores de '
'Movistar OFERTA FIBRA -63 DESCUENTO 900 104...',
'link': 'http://www.movistar.es/particulares/test-de-velocidad/',
'title': 'Test Velocidad ADSL y Fibra - Mide la velocidad de tu '
'Internet - Movistar'},
{ 'google_stats': 'Aproximadamente 3.090.000.000 resultados(0,34 '
'segundos)',
'how_many_results': 10,
'related_search': [ 'testcuriosos',
'testdivertidos',
'testpara adolescentes',
'tests de personalidad',
'tests divertidos para pasar el rato',
'testjuegos',
'testde belleza',
'tests de amor'],
'stats': { 'google_search_time': '0.8270025253295898 s',
'overall_time': '0.8999979496002197 s',
'parsing_page_time': '0.040498971939086914 s'},
'url': 'https://www.google.com/search?q=test'}]

At this case, I am in Spain, so the results language are based on your **current location** (if you *do not specify one*).

If another page must be searched, all the methods start with: ``with``. You can find more instructions at the `wiki <https://github.com/Javinator9889/pyGle/wiki>`__.

3. Installation
---------------

As usual, you have the `pip <https://pypi.org/project/pip/>`__ mode or the `easy install <https://setuptools.readthedocs.io/en/latest/easy_install.html>`__ methods:

*The commands for Windows are the same but without* ``sudo``

*Installing via PyPi (pip)*
~~~~~~~~~~~~~~~~~~~~~~~~~~~

- In some Linux systems, *pip* is not directly available in command line, so we have two options:

*Installing pip for Python 3* (assuming that you **already have Python 3 installed**):

.. code:: bash

## DEBIAN SYSTEMS ##
sudo apt update && sudo apt upgrade
sudo apt-get install python3-pip

.. code:: bash

## CENTOS ##
sudo yum install python34-setuptools
sudo easy_install pip

- Installing `pyGle <https://github.com/Javinator9889/pyGle>`__:

Once you did what said before, now you are able to install `pyGle <https://github.com/Javinator9889/pyGle>`__

.. code:: bash

#### USING PIP ####
sudo pip3 install g-pyGle

## If pip3 is not available ##
sudo pip install g-pyGle

## Via Python 3 ##
sudo python3 -m pip install g-pyGle

## Without admin permissions ##
pip3 install -U g-pyGle
OR
python3 -m pip install -U g-pyGle

*Installing via easy install*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Basically, we will install *Python 3* on our systems, and then we will be able to install `pyGle <https://github.com/Javinator9889/pyGle>`__:

- `Windows <https://realpython.com/installing-python/#windows>`__
- `Linux (all systems) <https://realpython.com/installing-python/#linux>`__
- `MacOS <https://realpython.com/installing-python/#macos-mac-os-x>`__
- `iOS <https://realpython.com/installing-python/#ios-iphone-ipad>`__
- `Android <https://realpython.com/installing-python/#android-phones-tablets>`__

- Now, we can install `pyGle <https://github.com/Javinator9889/pyGle>`__ as follows:

.. code:: bash

#### USING EASY INSTALL ####
git clone https://github.com/Javinator9889/pyGle.git
cd pyGle
sudo python3 setup.py install

4. Instructions
---------------

Every time we want to use `pyGle <https://github.com/Javinator9889/pyGle>`__, we will do the following:

.. code:: python

from pyGle import PyGle

`pyGle <https://github.com/Javinator9889/pyGle>`__ allows us to **enable a history** and **keep the session cookies** (for a faster browsing):

.. code:: python

pSearch = PyGle(enable_history=True, use_session_cookies=True)

As normal, `pyGle <https://github.com/Javinator9889/pyGle>`__ will only do a normal Google search if we add a query:

.. code:: python

pSearch.withQuery("what we want to search")

Also, with every method, you can continue *defining your needs* without **creating thousands** of lines of code:

.. code:: python

pSearch.withQuery("what we want to search").withContainingTwoTerms("term 1", "term 2").withTextInTitle("text in title").withSafeModeDeactivated().withSearchStartPositionAt(25)

Once we are done, searching is as simple as:

.. code:: python

ft = pSearch.doSearch()

# Wait for the result to be available
search_results = ft.result()

Finally, we can recover (if enabled) all the history of the search we did just:

.. code:: python

history = pSearch.getHistory()

# Or printing history
pSearch.pprintHistory()

*If you want to read more, have a look at the *`wiki <https://github.com/Javinator9889/pyGle/wiki>`__.

*Torify*
~~~~~~~~

Another functionality included with this lib is the possibility to work under **Tor**.

If you do not know what is it, **Tor** is the *easiest way* to browse the web anonymously by using proxies that hide yourself. You can read more `right here <https://lifehacker.com/what-is-tor-and-should-i-use-it-1527891029>`__.

If you want *to use this functionality*, you need to have Tor installed on your system. Here you have the instructions for your systems:

- `Windows <https://www.quora.com/How-do-I-run-Tor-headless-on-Windows-10>`__
- `Linux <https://www.torproject.org/docs/debian.html.en>`__
- `MacOS <https://www.torproject.org/docs/tor-doc-osx.html.en>`__
- `Android <https://www.torproject.org/docs/android.html.en>`__

Finally, once Tor is configured on your system, for using it is as simple as (*following the latest example*):

.. code:: python

ft = pSearch.doSearch(torify=True)

5. Contribute
-------------

If you really appreciate my work, you can *contribute to this project* perfectly, for example:

1. If you find **bugs** 馃攷馃悶, you can comment at `issues <https://github.com/Javinator9889/pyGle/issues>`__ what happened to you and *I will try to find a solution*.
2. You can **fork** this repository and *include all what you think* `pyGle <https://github.com/Javinator9889/pyGle>`__ should have. Create a pull request and, if I like your changes, I will include it on the official repo and you will automatically become a developer and maintainer 馃槃
3. Also, if you are a great fan, you can donate me what you want by clicking here 馃

|Donate me|

6. License
----------

::

Copyright (C) 2018 - Javinator9889 - pyGle

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.`

.. |PyPi| image:: https://img.shields.io/badge/v1.24%20-PyPi-green.svg
:target: https://pypi.org/project/g-pyGle/
.. |ZIP| image:: https://img.shields.io/badge/Package%20-Zip-blue.svg
:target: https://github.com/Javinator9889/pyGle/archive/master.zip
.. |GIT| image:: https://img.shields.io/badge/Package%20-Git-red.svg
:target: https://github.com/Javinator9889/pyGle.git
.. |Donate me| image:: http://pluspng.com/img-png/paypal-donate-button-png-paypal-donate-button-png-file-png-image-200.png
:target: https://paypal.me/Javinator9889

Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for g-pyGle, version 1.25
Filename, size File type Python version Upload date Hashes
Filename, size g-pyGle-1.25.tar.gz (36.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page