Skip to content

add maps engine examples #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 17, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions samples/maps_engine/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
This sample code demonstrates use of the Google Maps Engine API, including
listing projects, listing tables within a project, and uploading a shapefile.

For more information see https://developers.google.com/maps-engine/documentation

api: mapsengine
keywords: cmdline
author: Josh Livni
170 changes: 170 additions & 0 deletions samples/maps_engine/maps_engine.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
# -*- coding: utf-8 -*-
#
# Copyright 2013 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Simple command-line sample for Google Maps Engine.

This sample code demonstrates use of the Google Maps Engine API. For more
information on the API, see developers.google.com/maps-engine/documentation/

These samples allow you to
1) List projects you have access to
2) List tables in a given project.
3) Upload a shapefile to create a Table asset.

Usage:
$ python maps_engine.py [-p project_id] [-s shapefile]

If you do not enter a shapefile, it will upload the included "polygons".

You can also get help on all the command-line flags the program understands
by running:

$ python maps_engine.py --help

To get detailed log output run:

$ python maps_engine.py -p 123456 --logging_level=DEBUG
"""

__author__ = "jlivni@google.com (Josh Livni)"

import argparse
import json
import logging
import sys
import time

from apiclient import sample_tools
from apiclient.http import MediaFileUpload

logging.basicConfig(level=logging.INFO)

# Declare command-line flags.
argparser = argparse.ArgumentParser(add_help=False)
argparser.add_argument("-p", "--project_id", help="optional GME Project ID")
argparser.add_argument("-s", "--shapefile", help="Shapefile (without the .shp)")

SUCCESSFUL_STATUS = ["processed", "complete", "ready"]


class MapsEngineSampleException(Exception):
"""Catch this for failures specific to this sample code."""


def ListProjects(service):
"""List the projects available to the authorized account.

Args:
service: The service object built by the Google API Python client library.
"""
projects = service.projects().list().execute()
logging.info(json.dumps(projects, indent=2))


def ListTables(service, project_id):
"""List the tables in a given project.

Args:
service: The service object built by the Google API Python client library.
project_id: string, id of the GME project.
"""

tables = service.tables().list(projectId=project_id).execute()
logging.info(json.dumps(tables, indent=2))


def UploadShapefile(service, project_id, shapefile_prefix):
"""Upload a shapefile to a given project, and display status when complete.

Args:
service: The service object built by the Google API Python client library.
project_id: string, id of the GME project.
shapefile_prefix: string, the shapefile without the .shp suffix.

Returns:
String id of the table asset.
"""
# A shapefile is actually a bunch of files; GME requires these four suffixes.
suffixes = ["shp", "dbf", "prj", "shx"]
files = []
for suffix in suffixes:
files.append({
"filename": "%s.%s" % (shapefile_prefix, suffix)
})
metadata = {
"projectId": project_id,
"name": shapefile_prefix,
"description": "polygons that were uploaded by a script",
"files": files,
# You need the string value of a valid shared and published ACL
# Check the "Access Lists" section of the Maps Engine UI for a list.
"draftAccessList": "Map Editors",
"tags": [shapefile_prefix, "auto_upload", "kittens"]
}

logging.info("Uploading metadata for %s", shapefile_prefix)
response = service.tables().upload(body=metadata).execute()
# We have now created an empty asset.
table_id = response["id"]

# And now upload each of the files individually, passing in the table id.
for suffix in suffixes:
shapefile = "%s.%s" % (shapefile_prefix, suffix)
media_body = MediaFileUpload(shapefile, mimetype="application/octet-stream")
logging.info("uploading %s", shapefile)

response = service.tables().files().insert(
id=table_id,
filename=shapefile,
media_body=media_body).execute()

# With all files uploaded, check status of the asset to ensure it's processed.
CheckAssetStatus(service, "tables", table_id)
return table_id


def CheckAssetStatus(service, asset_type, asset_id):
endpoint = getattr(service, asset_type)
response = endpoint().get(id=asset_id).execute()
status = response["processingStatus"]
logging.info("Asset Status: %s", status)
if status in SUCCESSFUL_STATUS:
logging.info("asset successfully processed; the id is %s", asset_id)
else:
logging.info("Asset %s; will check again in 5 seconds", status)
time.sleep(5)
CheckAssetStatus(service, asset_type, asset_id)


def main(argv):
# Authenticate and construct service.
service, flags = sample_tools.init(
argv, "mapsengine", "v1", __doc__, __file__, parents=[argparser],
scope="https://www.googleapis.com/auth/mapsengine")

if flags.project_id:
# ListTables(service, flags.project_id)
# The example polygons shapefile should be in this directory.
filename = flags.shapefile or "polygons"
table_id = UploadShapefile(service, flags.project_id, filename)
logging.info("Sucessfully created table: %s", table_id)
else:
ListProjects(service)
return


if __name__ == "__main__":
main(sys.argv)
Binary file added samples/maps_engine/polygons.dbf
Binary file not shown.
1 change: 1 addition & 0 deletions samples/maps_engine/polygons.prj
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
GEOGCS["GCS_WGS_1984",DATUM["D_WGS_1984",SPHEROID["WGS_1984",6378137,298.257223563]],PRIMEM["Greenwich",0],UNIT["Degree",0.017453292519943295]]
Binary file added samples/maps_engine/polygons.shp
Binary file not shown.
Binary file added samples/maps_engine/polygons.shx
Binary file not shown.