google-streetview 1.1.7

Report Contributions

Reports for issues and suggestions can be made using the issue submission interface.

When possible, ensure that your submission is:

• Descriptive: has informative title, explanations, and screenshots

• Specific: has details of environment (such as operating system and hardware) and software used

• Reproducible: has steps, code, and examples to reproduce the issue

Code Contributions

Code contributions are submitted via pull requests:

1. Ensure that you pass the Tests

2. Create a new pull request

3. Provide an explanation of the changes

A template of the code contribution explanation is provided below:

## Purpose

The purpose can mention goals that include fixes to bugs, addition of features, and other improvements, etc.

## Description

The description is a short summary of the changes made such as improved speeds, implementation

## Changes

The changes are a list of general edits made to the files and their respective components.

* `file_path1`:
  * `function_module_etc`: changed loop to map
  * `function_module_etc`: changed variable value
* `file_path2`:
  * `function_module_etc`: changed loop to map
  * `function_module_etc`: changed variable value

## Notes

The notes provide any additional text that do not fit into the above sections.

For more information, see Developer Install and Implementation.

Developer Install

Install the latest developer version with pip from github:

pip install git+https://github.com/rrwen/google_streetview

Install from git cloned source:

1. Ensure git is installed

2. Clone into current path

3. Install via pip

git clone https://github.com/rrwen/google_streetview
cd google_streetview
pip install . -I

Tests

1. Clone into current path git clone https://github.com/rrwen/google_streetview

2. Enter into folder cd google_streetview

3. Ensure unittest is available

4. Set your Google API developer key

5. Run tests

6. Reset config file to defaults

7. Please note that this will use up 16 requests from your quota

pip install . -I
python -m google_streetview -s key=your_dev_key
python -m unittest
python -m google_streetview -d

Documentation Maintenance

1. Ensure sphinx is installed pip install -U sphinx

2. Update the documentation in docs/

pip install . -I
sphinx-build -b html docs/source docs

Upload to github

1. Ensure git is installed

2. Add all files and commit changes

3. Push to github

git add .
git commit -a -m "Generic update"
git push

Upload to PyPi

1. Ensure twine is installed pip install twine

2. Ensure sphinx is installed pip install -U sphinx

3. Run tests and check for OK status

4. Delete dist directory

5. Update the version google_streetview/__init__.py

6. Update the documentation in docs/

7. Create source distribution

8. Upload to PyPi

pip install . -I
python -m google_streetview -s key=your_dev_key
python -m unittest
python -m google_streetview -d
sphinx-build -b html docs/source docs
python setup.py sdist
twine upload dist/*

Implementation

The command line tool and module use query strings inside Uniform Resource Locators (URLs) that make requests to Google Street View Image API. The Python package requests were used to download the images from the URL requests from a dictionary passed to the google_streetview.api module.

Google Street View Image API
             |
URL Request with query string
             |
    google_streetview.api
             |
          request