Welcome to google-search’s documentation!¶

Contents:

google-search¶

Library for scraping google search results.

Usage:

from googlesearch.googlesearch import GoogleSearch
response = GoogleSearch().search("something")
for result in response.results:
    print("Title: " + result.title)
    print("Content: " + result.getText())

Free software: MIT license

Features¶

Run a Google search and fetch the individual results (full HTML and text contents). By default the result URLs are fetched eagerly when the search request is made with 10 parallel requests. Fetching can be deferred until searchResult.getText() or getMarkup() are called by passing prefetch_results = False to the search method.

Pass num_results to the search method to set the maximum number of results.

SearchReponse.total gives the total number of results on Google.

Credits¶

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation¶

Stable release¶

To install google-search, run this command in your terminal:

$ pip install google-search

This is the preferred method to install google-search, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for google-search can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/anthonyhseb/googlesearch

Or download the tarball:

$ curl  -OL https://github.com/anthonyhseb/googlesearch/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage¶

To use google-search in a project:

from googlesearch.googlesearch import GoogleSearch
response = GoogleSearch().search("something")
for result in response.results:
    print("Title: " + result.title)
    print("URL: " + result.url)
    print("Content: " + result.getText())
    print("Html: " + result.getMarkup())

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/anthonyhseb/googlesearch/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

google-search could always use more documentation, whether as part of the official google-search docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/anthonyhseb/googlesearch/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up googlesearch for local development.

Fork the googlesearch repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/googlesearch.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv googlesearch
$ cd googlesearch/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass the tests, including testing other Python versions with tox:
```
$ python setup.py test or py.test
$ tox
```

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6 and 2.7, and for PyPy. Check https://travis-ci.org/anthonyhseb/googlesearch/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_googlesearch