├── .gitignore
├── CONTRIB.md
├── LICENSE
├── README.md
├── app.yaml
├── helloworld_api.py
├── index.html
├── static
├── bootstrap
│ └── css
│ │ ├── bootstrap-responsive.css
│ │ └── bootstrap.css
└── js
│ └── base.js
└── templates
└── index.html
/.gitignore:
--------------------------------------------------------------------------------
1 | *.py[cod]
2 |
3 | # C extensions
4 | *.so
5 |
6 | # Packages
7 | *.egg
8 | *.egg-info
9 | dist
10 | build
11 | eggs
12 | parts
13 | bin
14 | var
15 | sdist
16 | develop-eggs
17 | .installed.cfg
18 | lib
19 | lib64
20 |
21 | # Installer logs
22 | pip-log.txt
23 |
24 | # Unit test / coverage reports
25 | .coverage
26 | .tox
27 | nosetests.xml
28 |
29 | # Translations
30 | *.mo
31 |
32 | # Mr Developer
33 | .mr.developer.cfg
34 | .project
35 | .pydevproject
36 |
--------------------------------------------------------------------------------
/CONTRIB.md:
--------------------------------------------------------------------------------
1 | # How to become a contributor and submit your own code
2 |
3 | ## Contributor License Agreements
4 |
5 | We'd love to accept your sample apps and patches! Before we can take them, we have to jump a couple of legal hurdles.
6 |
7 | Please fill out either the individual or corporate Contributor License Agreement (CLA).
8 |
9 | * If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html).
10 | * If you work for a company that wants to allow you to contribute your work, then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html).
11 |
12 | Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
13 |
14 | ## Contributing A Patch
15 |
16 | 1. Submit an issue describing your proposed change to the repo in question.
17 | 1. The repo owner will respond to your issue promptly.
18 | 1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
19 | 1. Fork the desired repo, develop and test your code changes.
20 | 1. Ensure that your code adheres to the existing style in the sample to which you are contributing. Refer to the [Google Cloud Platform Samples Style Guide](https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the recommended coding standards for this organization.
21 | 1. Ensure that your code has an appropriate set of unit tests which all pass.
22 | 1. Submit a pull request.
23 |
24 | ## Contributing A New Sample App
25 |
26 | 1. Submit an issue to the GoogleCloudPlatform/Template repo describing your proposed sample app.
27 | 1. The Template repo owner will respond to your enhancement issue promptly. Instructional value is the top priority when evaluating new app proposals for this collection of repos.
28 | 1. If your proposal is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
29 | 1. Create your own repo for your app following this naming convention:
30 | * {product}-{app-name}-{language}
31 | * products: appengine, compute, storage, bigquery, prediction, cloudsql
32 | * example: appengine-guestbook-python
33 | * For multi-product apps, concatenate the primary products, like this: compute-appengine-demo-suite-python.
34 | * For multi-language apps, concatenate the primary languages like this: appengine-sockets-python-java-go.
35 | 1. Clone the README.md, CONTRIB.md and LICENSE files from the GoogleCloudPlatform/Template repo.
36 | 1. Ensure that your code adheres to the existing style in the sample to which you are contributing. Refer to the [Google Cloud Platform Samples Style Guide](https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the recommended coding standards for this organization.
37 | 1. Ensure that your code has an appropriate set of unit tests which all pass.
38 | 1. Submit a request to fork your repo in GoogleCloudPlatform organizationt via your proposal issue.
39 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | Apache License
3 | Version 2.0, January 2004
4 | http://www.apache.org/licenses/
5 |
6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7 |
8 | 1. Definitions.
9 |
10 | "License" shall mean the terms and conditions for use, reproduction,
11 | and distribution as defined by Sections 1 through 9 of this document.
12 |
13 | "Licensor" shall mean the copyright owner or entity authorized by
14 | the copyright owner that is granting the License.
15 |
16 | "Legal Entity" shall mean the union of the acting entity and all
17 | other entities that control, are controlled by, or are under common
18 | control with that entity. For the purposes of this definition,
19 | "control" means (i) the power, direct or indirect, to cause the
20 | direction or management of such entity, whether by contract or
21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 | outstanding shares, or (iii) beneficial ownership of such entity.
23 |
24 | "You" (or "Your") shall mean an individual or Legal Entity
25 | exercising permissions granted by this License.
26 |
27 | "Source" form shall mean the preferred form for making modifications,
28 | including but not limited to software source code, documentation
29 | source, and configuration files.
30 |
31 | "Object" form shall mean any form resulting from mechanical
32 | transformation or translation of a Source form, including but
33 | not limited to compiled object code, generated documentation,
34 | and conversions to other media types.
35 |
36 | "Work" shall mean the work of authorship, whether in Source or
37 | Object form, made available under the License, as indicated by a
38 | copyright notice that is included in or attached to the work
39 | (an example is provided in the Appendix below).
40 |
41 | "Derivative Works" shall mean any work, whether in Source or Object
42 | form, that is based on (or derived from) the Work and for which the
43 | editorial revisions, annotations, elaborations, or other modifications
44 | represent, as a whole, an original work of authorship. For the purposes
45 | of this License, Derivative Works shall not include works that remain
46 | separable from, or merely link (or bind by name) to the interfaces of,
47 | the Work and Derivative Works thereof.
48 |
49 | "Contribution" shall mean any work of authorship, including
50 | the original version of the Work and any modifications or additions
51 | to that Work or Derivative Works thereof, that is intentionally
52 | submitted to Licensor for inclusion in the Work by the copyright owner
53 | or by an individual or Legal Entity authorized to submit on behalf of
54 | the copyright owner. For the purposes of this definition, "submitted"
55 | means any form of electronic, verbal, or written communication sent
56 | to the Licensor or its representatives, including but not limited to
57 | communication on electronic mailing lists, source code control systems,
58 | and issue tracking systems that are managed by, or on behalf of, the
59 | Licensor for the purpose of discussing and improving the Work, but
60 | excluding communication that is conspicuously marked or otherwise
61 | designated in writing by the copyright owner as "Not a Contribution."
62 |
63 | "Contributor" shall mean Licensor and any individual or Legal Entity
64 | on behalf of whom a Contribution has been received by Licensor and
65 | subsequently incorporated within the Work.
66 |
67 | 2. Grant of Copyright License. Subject to the terms and conditions of
68 | this License, each Contributor hereby grants to You a perpetual,
69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 | copyright license to reproduce, prepare Derivative Works of,
71 | publicly display, publicly perform, sublicense, and distribute the
72 | Work and such Derivative Works in Source or Object form.
73 |
74 | 3. Grant of Patent License. Subject to the terms and conditions of
75 | this License, each Contributor hereby grants to You a perpetual,
76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 | (except as stated in this section) patent license to make, have made,
78 | use, offer to sell, sell, import, and otherwise transfer the Work,
79 | where such license applies only to those patent claims licensable
80 | by such Contributor that are necessarily infringed by their
81 | Contribution(s) alone or by combination of their Contribution(s)
82 | with the Work to which such Contribution(s) was submitted. If You
83 | institute patent litigation against any entity (including a
84 | cross-claim or counterclaim in a lawsuit) alleging that the Work
85 | or a Contribution incorporated within the Work constitutes direct
86 | or contributory patent infringement, then any patent licenses
87 | granted to You under this License for that Work shall terminate
88 | as of the date such litigation is filed.
89 |
90 | 4. Redistribution. You may reproduce and distribute copies of the
91 | Work or Derivative Works thereof in any medium, with or without
92 | modifications, and in Source or Object form, provided that You
93 | meet the following conditions:
94 |
95 | (a) You must give any other recipients of the Work or
96 | Derivative Works a copy of this License; and
97 |
98 | (b) You must cause any modified files to carry prominent notices
99 | stating that You changed the files; and
100 |
101 | (c) You must retain, in the Source form of any Derivative Works
102 | that You distribute, all copyright, patent, trademark, and
103 | attribution notices from the Source form of the Work,
104 | excluding those notices that do not pertain to any part of
105 | the Derivative Works; and
106 |
107 | (d) If the Work includes a "NOTICE" text file as part of its
108 | distribution, then any Derivative Works that You distribute must
109 | include a readable copy of the attribution notices contained
110 | within such NOTICE file, excluding those notices that do not
111 | pertain to any part of the Derivative Works, in at least one
112 | of the following places: within a NOTICE text file distributed
113 | as part of the Derivative Works; within the Source form or
114 | documentation, if provided along with the Derivative Works; or,
115 | within a display generated by the Derivative Works, if and
116 | wherever such third-party notices normally appear. The contents
117 | of the NOTICE file are for informational purposes only and
118 | do not modify the License. You may add Your own attribution
119 | notices within Derivative Works that You distribute, alongside
120 | or as an addendum to the NOTICE text from the Work, provided
121 | that such additional attribution notices cannot be construed
122 | as modifying the License.
123 |
124 | You may add Your own copyright statement to Your modifications and
125 | may provide additional or different license terms and conditions
126 | for use, reproduction, or distribution of Your modifications, or
127 | for any such Derivative Works as a whole, provided Your use,
128 | reproduction, and distribution of the Work otherwise complies with
129 | the conditions stated in this License.
130 |
131 | 5. Submission of Contributions. Unless You explicitly state otherwise,
132 | any Contribution intentionally submitted for inclusion in the Work
133 | by You to the Licensor shall be under the terms and conditions of
134 | this License, without any additional terms or conditions.
135 | Notwithstanding the above, nothing herein shall supersede or modify
136 | the terms of any separate license agreement you may have executed
137 | with Licensor regarding such Contributions.
138 |
139 | 6. Trademarks. This License does not grant permission to use the trade
140 | names, trademarks, service marks, or product names of the Licensor,
141 | except as required for reasonable and customary use in describing the
142 | origin of the Work and reproducing the content of the NOTICE file.
143 |
144 | 7. Disclaimer of Warranty. Unless required by applicable law or
145 | agreed to in writing, Licensor provides the Work (and each
146 | Contributor provides its Contributions) on an "AS IS" BASIS,
147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 | implied, including, without limitation, any warranties or conditions
149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 | PARTICULAR PURPOSE. You are solely responsible for determining the
151 | appropriateness of using or redistributing the Work and assume any
152 | risks associated with Your exercise of permissions under this License.
153 |
154 | 8. Limitation of Liability. In no event and under no legal theory,
155 | whether in tort (including negligence), contract, or otherwise,
156 | unless required by applicable law (such as deliberate and grossly
157 | negligent acts) or agreed to in writing, shall any Contributor be
158 | liable to You for damages, including any direct, indirect, special,
159 | incidental, or consequential damages of any character arising as a
160 | result of this License or out of the use or inability to use the
161 | Work (including but not limited to damages for loss of goodwill,
162 | work stoppage, computer failure or malfunction, or any and all
163 | other commercial damages or losses), even if such Contributor
164 | has been advised of the possibility of such damages.
165 |
166 | 9. Accepting Warranty or Additional Liability. While redistributing
167 | the Work or Derivative Works thereof, You may choose to offer,
168 | and charge a fee for, acceptance of support, warranty, indemnity,
169 | or other liability obligations and/or rights consistent with this
170 | License. However, in accepting such obligations, You may act only
171 | on Your own behalf and on Your sole responsibility, not on behalf
172 | of any other Contributor, and only if You agree to indemnify,
173 | defend, and hold each Contributor harmless for any liability
174 | incurred by, or claims asserted against, such Contributor by reason
175 | of your accepting any such warranty or additional liability.
176 |
177 | END OF TERMS AND CONDITIONS
178 |
179 | APPENDIX: How to apply the Apache License to your work.
180 |
181 | To apply the Apache License to your work, attach the following
182 | boilerplate notice, with the fields enclosed by brackets "[]"
183 | replaced with your own identifying information. (Don't include
184 | the brackets!) The text should be enclosed in the appropriate
185 | comment syntax for the file format. We also recommend that a
186 | file or class name and description of purpose be included on the
187 | same "printed page" as the copyright notice for easier
188 | identification within third-party archives.
189 |
190 | Copyright [yyyy] [name of copyright owner]
191 |
192 | Licensed under the Apache License, Version 2.0 (the "License");
193 | you may not use this file except in compliance with the License.
194 | You may obtain a copy of the License at
195 |
196 | http://www.apache.org/licenses/LICENSE-2.0
197 |
198 | Unless required by applicable law or agreed to in writing, software
199 | distributed under the License is distributed on an "AS IS" BASIS,
200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 | See the License for the specific language governing permissions and
202 | limitations under the License.
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | This sample has been moved to [GoogleCloudPlatform/python-docs-samples](https://github.com/GoogleCloudPlatform/python-docs-samples).
4 |
5 | ## Hello Endpoints Python
6 |
7 | A Python "Hello World" skeleton application for Google App Engine using
8 | [Google Cloud Endpoints][1].
9 |
10 | See our other [Google Cloud Platform github
11 | repos](https://github.com/GoogleCloudPlatform) for sample applications and
12 | scaffolding for other Python frameworks and use cases.
13 |
14 | ## Run Locally
15 | 1. Install the [App Engine Python SDK](https://developers.google.com/appengine/downloads).
16 | See the README file for directions. You'll need Python 2.7 installed too.
17 |
18 | 1. Clone this repo with
19 |
20 | ```
21 | git clone https://github.com/GoogleCloudPlatform/appengine-endpoints-helloendpoints-python.git
22 | ```
23 | 1. Run the application locally with
24 |
25 | ```
26 | cd appengine-endpoints-helloendpoints-python
27 | dev_appserver.py .
28 | ```
29 | 1. Test your Endpoints by visiting the Google APIs Explorer (by default [http://localhost:8000/_ah/api/explorer](http://localhost:8000/_ah/api/explorer))
30 |
31 | ## Deploy
32 | To deploy the application:
33 |
34 | 1. Use the [Admin Console](https://appengine.google.com) to create an app.
35 | 1. Replace `your-app-id` in `app.yaml` with the app id from the previous step.
36 | 1. Optional step: These sub steps are not required but will enable the "Authenticated
37 | Greeting" functionality.
38 | 1. Update the values in `helloworld_api.py` to
39 | reflect the respective client IDs you have registered in the [console][3].
40 | 1. Update the value of `google.devrel.samples.helloendpoints.CLIENT_ID` in
41 | `static/js/base.js` to reflect the web client ID you have registered in the
42 | [console][3].
43 | 1. [Deploy the application](https://developers.google.com/appengine/docs/python/tools/uploadinganapp)
44 | with:
45 |
46 | ```
47 | appcfg.py --oauth2 update .
48 | ```
49 | or use the App Engine Launcher.
50 | 1. Congratulations! Your application is now live at `your-app-id`.appspot.com.
51 | 1. [Generate the Android client library][2] with:
52 |
53 | ```
54 | endpointscfg.py get_client_lib java -o . helloworld_api.HelloWorldApi
55 | ```
56 |
57 | or for Gradle projects:
58 | ```
59 | endpointscfg.py get_client_lib java -bs gradle -o . helloworld_api.HelloWorldApi
60 | ```
61 | The library will connect to your deployed application. If you change your app ID, you must regenerate the client library.
62 |
63 | ## Next Steps
64 | This skeleton includes TODO markers you can search for to determine some of the
65 | basic areas you will want to customize.
66 |
67 | ### Consuming APIs
68 | Building the backend is one part of Cloud Endpoints. See how you can consume
69 | your APIs from [Android](https://developers.google.com/appengine/docs/python/endpoints/consume_android),
70 | [iOS](https://developers.google.com/appengine/docs/python/endpoints/consume_ios), or the
71 | [web](https://developers.google.com/appengine/docs/python/endpoints/consume_js) by reading the documentation.
72 |
73 | ### Installing Libraries
74 | See the [third-party
75 | libraries](https://developers.google.com/appengine/docs/python/tools/libraries27)
76 | page for libraries that are already included in the SDK. To include SDK
77 | libraries, add them in your app.yaml file. Other than libraries included in
78 | the SDK, only pure python libraries may be added to an App Engine project.
79 |
80 | ### Feedback
81 | Star this repo if you found it useful. Use the github issue tracker to give
82 | feedback on this repo and to ask for scaffolds for other use cases.
83 |
84 | ## Contributing changes
85 | See [CONTRIB.md](CONTRIB.md)
86 |
87 | ## Licensing
88 | See [LICENSE](LICENSE)
89 |
90 | [1]: https://developers.google.com/appengine/docs/python/endpoints/
91 | [2]: https://developers.google.com/appengine/docs/python/endpoints/gen_clients
92 | [3]: https://cloud.google.com/console
93 |
--------------------------------------------------------------------------------
/app.yaml:
--------------------------------------------------------------------------------
1 | # This file specifies your Python application's runtime configuration
2 | # including URL routing, versions, static file uploads, etc. See
3 | # https://developers.google.com/appengine/docs/python/config/appconfig
4 | # for details.
5 |
6 | # TODO: Enter your application id below. If you have signed up
7 | # using cloud.google.com/console use the "project id" for your application
8 | # id.
9 | application: your-app-id
10 | version: 1
11 | runtime: python27
12 | threadsafe: true
13 | api_version: 1
14 |
15 | # Handlers tell App Engine how to route requests to your application.
16 | handlers:
17 |
18 | # The following three handlers route requests to static resources: JS, CSS,
19 | # and HTML.
20 | - url: /js
21 | static_dir: static/js
22 | - url: /bootstrap
23 | static_dir: static/bootstrap
24 | - url: /
25 | static_files: templates/index.html
26 | upload: templates/index\.html
27 |
28 | # This handler routes requests to your APIs to your Endpoints code.
29 | # See https://developers.google.com/appengine/docs/python/endpoints/
30 | - url: /_ah/spi/.*
31 | script: helloworld_api.APPLICATION
32 |
33 | # Third party libraries that are included in the App Engine SDK must be listed
34 | # here if you want to use them. See
35 | # https://developers.google.com/appengine/docs/python/tools/libraries27 for
36 | # a list of libraries included in the SDK. Third party libs that are *not* part
37 | # of the App Engine SDK don't need to be listed here, instead add them to your
38 | # project directory, either as a git submodule or as a plain subdirectory.
39 | # Note that dependencies must be located in your project directory - packages
40 | # installed in the Python environment are not loaded by the App Engine
41 | # development server or deployment tools.
42 | # TODO: List any other App Engine SDK libs you may need here.
43 | libraries:
44 |
45 | # You must include the Endpoints library if you wish to serve an API.
46 | - name: endpoints
47 | version: 1.0
48 |
49 | # The pycrypto library is used for OAuth 2, and is also a requirement for
50 | # APIs that wish to authenticate users.
51 | - name: pycrypto
52 | version: latest
53 |
--------------------------------------------------------------------------------
/helloworld_api.py:
--------------------------------------------------------------------------------
1 | """Hello World API implemented using Google Cloud Endpoints.
2 |
3 | Defined here are the ProtoRPC messages needed to define Schemas for methods
4 | as well as those methods defined in an API.
5 | """
6 |
7 |
8 | import endpoints
9 | from protorpc import messages
10 | from protorpc import message_types
11 | from protorpc import remote
12 |
13 |
14 | # TODO: Replace the following lines with client IDs obtained from the APIs
15 | # Console or Cloud Console.
16 | WEB_CLIENT_ID = 'replace this with your web client application ID'
17 | ANDROID_CLIENT_ID = 'replace this with your Android client ID'
18 | IOS_CLIENT_ID = 'replace this with your iOS client ID'
19 | ANDROID_AUDIENCE = WEB_CLIENT_ID
20 |
21 |
22 | package = 'Hello'
23 |
24 |
25 | class Greeting(messages.Message):
26 | """Greeting that stores a message."""
27 | message = messages.StringField(1)
28 |
29 |
30 | class GreetingCollection(messages.Message):
31 | """Collection of Greetings."""
32 | items = messages.MessageField(Greeting, 1, repeated=True)
33 |
34 |
35 | STORED_GREETINGS = GreetingCollection(items=[
36 | Greeting(message='hello world!'),
37 | Greeting(message='goodbye world!'),
38 | ])
39 |
40 |
41 | @endpoints.api(name='helloworld', version='v1',
42 | allowed_client_ids=[WEB_CLIENT_ID, ANDROID_CLIENT_ID,
43 | IOS_CLIENT_ID],
44 | audiences=[ANDROID_AUDIENCE])
45 | class HelloWorldApi(remote.Service):
46 | """Helloworld API v1."""
47 |
48 | MULTIPLY_METHOD_RESOURCE = endpoints.ResourceContainer(
49 | Greeting,
50 | times=messages.IntegerField(2, variant=messages.Variant.INT32,
51 | required=True))
52 |
53 | @endpoints.method(MULTIPLY_METHOD_RESOURCE, Greeting,
54 | path='hellogreeting/{times}', http_method='POST',
55 | name='greetings.multiply')
56 | def greetings_multiply(self, request):
57 | return Greeting(message=request.message * request.times)
58 |
59 | @endpoints.method(message_types.VoidMessage, GreetingCollection,
60 | path='hellogreeting', http_method='GET',
61 | name='greetings.listGreeting')
62 | def greetings_list(self, unused_request):
63 | return STORED_GREETINGS
64 |
65 | ID_RESOURCE = endpoints.ResourceContainer(
66 | message_types.VoidMessage,
67 | id=messages.IntegerField(1, variant=messages.Variant.INT32))
68 |
69 | @endpoints.method(ID_RESOURCE, Greeting,
70 | path='hellogreeting/{id}', http_method='GET',
71 | name='greetings.getGreeting')
72 | def greeting_get(self, request):
73 | try:
74 | return STORED_GREETINGS.items[request.id]
75 | except (IndexError, TypeError):
76 | raise endpoints.NotFoundException('Greeting %s not found.' %
77 | (request.id,))
78 |
79 | @endpoints.method(message_types.VoidMessage, Greeting,
80 | path='hellogreeting/authed', http_method='POST',
81 | name='greetings.authed')
82 | def greeting_authed(self, request):
83 | current_user = endpoints.get_current_user()
84 | email = (current_user.email() if current_user is not None
85 | else 'Anonymous')
86 | return Greeting(message='hello %s' % (email,))
87 |
88 |
89 | APPLICATION = endpoints.api_server([HelloWorldApi])
90 |
--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Hello Endpoints!
5 |
6 |
55 |
56 |
57 |
58 |
63 |
64 |
68 |
69 |
75 |
76 |
80 |
81 |
86 |
87 |
Hello Endpoints!
5 |
6 |
55 |
56 |
57 |
58 |
63 |
64 |
68 |
69 |
75 |
76 |
80 |
81 |
86 |
87 |