From 8ce42e71819cd8ddffc528cb5e4acb354cf1d78d Mon Sep 17 00:00:00 2001 From: elibixby Date: Tue, 5 May 2015 10:35:30 -0700 Subject: [PATCH 1/3] Initial commit from datastore-samples --- datastore/ndb/overview/README.md | 57 ++++++ datastore/ndb/overview/app.yaml | 22 +++ datastore/ndb/overview/favicon.ico | Bin 0 -> 8348 bytes datastore/ndb/overview/index.yaml | 17 ++ datastore/ndb/overview/main.py | 79 +++++++++ datastore/ndb/transactions/README.md | 61 +++++++ datastore/ndb/transactions/app.yaml | 18 ++ .../ndb/transactions/appengine_config.py | 11 ++ datastore/ndb/transactions/favicon.ico | Bin 0 -> 8348 bytes datastore/ndb/transactions/main.py | 162 ++++++++++++++++++ datastore/ndb/transactions/requirements.txt | 7 + 11 files changed, 434 insertions(+) create mode 100644 datastore/ndb/overview/README.md create mode 100644 datastore/ndb/overview/app.yaml create mode 100644 datastore/ndb/overview/favicon.ico create mode 100644 datastore/ndb/overview/index.yaml create mode 100644 datastore/ndb/overview/main.py create mode 100644 datastore/ndb/transactions/README.md create mode 100644 datastore/ndb/transactions/app.yaml create mode 100644 datastore/ndb/transactions/appengine_config.py create mode 100644 datastore/ndb/transactions/favicon.ico create mode 100644 datastore/ndb/transactions/main.py create mode 100644 datastore/ndb/transactions/requirements.txt diff --git a/datastore/ndb/overview/README.md b/datastore/ndb/overview/README.md new file mode 100644 index 000000000000..098498d50b88 --- /dev/null +++ b/datastore/ndb/overview/README.md @@ -0,0 +1,57 @@ +## NDB Overview Sample + +This is a sample app for Google App Engine that exercises the [NDB Python API](https://cloud.google.com/appengine/docs/python/ndb/). + +See our other [Google Cloud Platform github +repos](https://github.com/GoogleCloudPlatform) for sample applications and +scaffolding for other python frameworks and use cases. + +## Run Locally +1. Install the [Google Cloud SDK](https://cloud.google.com/sdk/), including the [gcloud tool](https://cloud.google.com/sdk/gcloud/), and [gcloud app component](https://cloud.google.com/sdk/gcloud-app). +2. Setup the gcloud tool. + + ``` + gcloud components update app + gcloud auth login + gcloud config set project + ``` + You don't need a valid app-id to run locally, but will need a valid id to deploy below. + +1. Clone this repo. + + ``` + git clone https://github.com/GoogleCloudPlatform/datastore-pthon-samples.git + cd datastore-python-samples/ndb-overview + ``` +1. Run this project locally from the command line. + + ``` + gcloud preview app run ./ + ``` + +1. Visit the application at [http://localhost:8080](http://localhost:8080). + +## Deploying + +1. Use the [Cloud Developer Console](https://console.developer.google.com) to create a project/app id. (App id and project id are identical) +2. Configure gcloud with your app id. + + ``` + gcloud config set project + ``` +1. Use the [Admin Console](https://appengine.google.com) to view data, queues, and other App Engine specific administration tasks. +1. Use gcloud to deploy your app. + + ``` + gcloud preview app deploy ./ + ``` + +1. Congratulations! Your application is now live at your-app-id.appspot.com + +## Contributing changes + +* See [CONTRIBUTING.md](../../CONTRIBUTING.md) + +## Licensing + +* See [LICENSE](../../LICENSE) diff --git a/datastore/ndb/overview/app.yaml b/datastore/ndb/overview/app.yaml new file mode 100644 index 000000000000..5227472ff0cf --- /dev/null +++ b/datastore/ndb/overview/app.yaml @@ -0,0 +1,22 @@ +# This file specifies your Python application's runtime configuration +# including URL routing, versions, static file uploads, etc. See +# https://developers.google.com/appengine/docs/python/config/appconfig +# for details. + +version: 1 +runtime: python27 +api_version: 1 +threadsafe: yes + +# Handlers define how to route requests to your application. +handlers: + +# This handler tells app engine how to route requests to a WSGI application. +# The script value is in the format . +# where is a WSGI application object. +- url: .* # This regex directs all routes to main.app + script: main.app + +libraries: +- name: webapp2 + version: "2.5.2" diff --git a/datastore/ndb/overview/favicon.ico b/datastore/ndb/overview/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..23c553a2966ca4cecf146093f33d8114b4f1e368 GIT binary patch literal 8348 zcmeI0du&tJ8Ng3Vwv|ewX4Hu@my&|vCD%DN@CLnxyptBT_%HjatoYr7%N3zGPed#@ckvA><;HWecDU4&2}*2(h%gm&WgCftWj zkQfW;&mXr@0S&(csd+cjaImbXSy=NC<10}z(efGwgi=;B$dt=HkKYCvp-#3KX+qIu zxx$>zcwk+N=c%1^J9)sO44lmS0##~wzU(43f>wW-p_YXwj>s>3{gHI*^oo1lmJ!X*bw{3UBAKRut zUh5Uy4_94IIkdxC^v{_g%FjuEI+f&;9KQ3i+nK7pU_RivFjP_DTl-&gP_qr$nD=M{ z@z;C3#y5Jsh77svGQ4u$ZX)t}=e52{#Xvk;4qIxNh86kR$OhCAie%&e`U{r{ACQZ@ z-)1#sItef{2L za&U;nm+_lo@lbR7vat&^EcECsH)uSnhlht@etsV4LE5B`j#GW*iur~}xpYlTtc;FC{nl|LK^miZ0y3WU>MIM zmc}94VzEFx9?#&?4l+h;ggzvOeCI$ob=`tBp*&EtirH2xU z4a#KB)IMa{_YdYrnxq>-DrrQ>rfpYe8@|Nc-oHnG*L(HR$}d4Eo2&X@o1~9l@%@W) zU{%rv$`tBAOHJH+?zcv7`!T~x;=<#7@4R5T^5$-%Pz-NAYt+5{d;>R+9W24y&`;ZkZqFGQ6_)<35Z_$5V#ga#=N9985-M0KR*fl@h4M0BxWvbYQr6t zULtYBAMJ%iU>x|?U8z_Zyv1jg_VcZ^kO)pd_)jk`_~2MHZmybbloW?l)lnMrb~TAX zV&%#e+VLvM4!%js+%B6}N!=udFlN5Jv;yQm0sdW({6ny+{{$_b`%pI&q3%#p3R?q( z%3@zpafPo4-GA}ErIfU@j?gpfdgeyI);;S-otz(GefQbXvG3J6hbwD_0*YOuqb1V8 zpQm{(oT|g$!tcw;Ck6l>=mo$z0J@0f0^U0{x?+mD8}QB{9yV7qQ;&$5^%*fb@qUB& zX(O<{D-aZ493K;1xH%!}9+}vt8Sshs4os9)d132glTa=lIJv}MJyU_Y!ZFl62j9@l zggg2y{y~c&Vm0cMa@}r@bbn?HR4Sa|66p;nlMl_6D%_%EjCNRq)NBvx!R!t`@zUoW zKV#O#EhZy4>~?VU+rfg@_W_4Kt~zS<|3JjVMcZ#exy;pDUypq|xjpD&0#H{BHgrvM zI=z9nnTN~NCX?mf@DOU;!82-#gXGsw5CSSf22lJ>u8duE&igGuZq4lVZf*LH2%QqOqkv@O{w`Y}q~yWm0EP zeSP~Hau49ZBU@&hWwH5YG0dnGVN1^iztQFh>rIvj5$iQ;q^nyuSuXo`U~{E8DpuIS zA{kR5oC9o=_>jhfRX@QTs1KRm{@F31 zFKP1!w?51@R^I~kA%H*B0W^sKnyVIsv`_2;=zbUGR9pOTqUhV{{^UH=RQ2@S?`uaQ zEy`)Gsd}1IEedW&4lAe0Sg5h`nQXqaZ}RyEzX{FT?hmF3>0_QQT1V~jI$wc&1@aZh ZS0G=3d706zJ{{SaIO|Jj| literal 0 HcmV?d00001 diff --git a/datastore/ndb/overview/index.yaml b/datastore/ndb/overview/index.yaml new file mode 100644 index 000000000000..f933a1c8e6d2 --- /dev/null +++ b/datastore/ndb/overview/index.yaml @@ -0,0 +1,17 @@ +indexes: + +# AUTOGENERATED + +# This index.yaml is automatically updated whenever the dev_appserver +# detects that a new type of query is run. If you want to manage the +# index.yaml file manually, remove the above marker line (the line +# saying "# AUTOGENERATED"). If you want to manage some indexes +# manually, move them above the marker line. The index.yaml file is +# automatically uploaded to the admin console when you next deploy +# your application using appcfg.py. + +- kind: Greeting + ancestor: yes + properties: + - name: date + direction: desc diff --git a/datastore/ndb/overview/main.py b/datastore/ndb/overview/main.py new file mode 100644 index 000000000000..91befce85f0d --- /dev/null +++ b/datastore/ndb/overview/main.py @@ -0,0 +1,79 @@ +# Copyright 2015 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. + +# [START all] +import cgi +import urllib + +import webapp2 + +from google.appengine.ext import ndb + + +# [START greeting] +class Greeting(ndb.Model): + """Models an individual Guestbook entry with content and date.""" + content = ndb.StringProperty() + date = ndb.DateTimeProperty(auto_now_add=True) +# [END greeting] + +# [START query] + @classmethod + def query_book(cls, ancestor_key): + return cls.query(ancestor=ancestor_key).order(-cls.date) + + +class MainPage(webapp2.RequestHandler): + def get(self): + self.response.out.write('') + guestbook_name = self.request.get('guestbook_name') + ancestor_key = ndb.Key("Book", guestbook_name or "*notitle*") + greetings = Greeting.query_book(ancestor_key).fetch(20) + + for greeting in greetings: + self.response.out.write('
%s
' % + cgi.escape(greeting.content)) +# [END query] + + self.response.out.write(""" +
+
+
+
+
+
Guestbook name: +
+ + """ % (urllib.urlencode({'guestbook_name': guestbook_name}), + cgi.escape(guestbook_name))) + + +# [START submit] +class SubmitForm(webapp2.RequestHandler): + def post(self): + # We set the parent key on each 'Greeting' to ensure each guestbook's + # greetings are in the same entity group. + guestbook_name = self.request.get('guestbook_name') + greeting = Greeting(parent=ndb.Key("Book", guestbook_name or "*notitle*"), + content=self.request.get('content')) + greeting.put() +# [END submit] + self.redirect('/?' + urllib.urlencode({'guestbook_name': guestbook_name})) + + +app = webapp2.WSGIApplication([ + ('/', MainPage), + ('/sign', SubmitForm) +]) +# [END all] diff --git a/datastore/ndb/transactions/README.md b/datastore/ndb/transactions/README.md new file mode 100644 index 000000000000..39c983ae0aca --- /dev/null +++ b/datastore/ndb/transactions/README.md @@ -0,0 +1,61 @@ +## NDB Transactions Sample + +This is a sample app for Google App Engine that exercises the [NDB Transactions Python API](https://cloud-dot-devsite.googleplex.com/appengine/docs/python/ndb/transactions) + +This app presents a list of notes. After you submit a note with a particular title, you may not change that note or submit a new note with the same title. There are multiple note pages available. + +See our other [Google Cloud Platform github +repos](https://github.com/GoogleCloudPlatform) for sample applications and +scaffolding for other python frameworks and use cases. + +## Run Locally +1. Install the [Google Cloud SDK](https://cloud.google.com/sdk/), including the [gcloud tool](https://cloud.google.com/sdk/gcloud/), and [gcloud app component](https://cloud.google.com/sdk/gcloud-app). +2. Setup the gcloud tool. + + ``` + gcloud components update app + gcloud auth login + gcloud config set project + ``` + You don't need a valid app-id to run locally, but will need a valid id to deploy below. + +1. Clone this repo. + + ``` + git clone https://github.com/GoogleCloudPlatform/datastore-samples.git + cd datastore-samples/python/ndb/transactions + ``` +1. Run this project locally from the command line. + + ``` + pip install -r requirements.txt -t lib/ + gcloud preview app run ./app.yaml + ``` + +1. Visit the application at [http://localhost:8080](http://localhost:8080). + +## Deploying + +1. Use the [Cloud Developer Console](https://console.developer.google.com) to create a project/app id. (App id and project id are identical) +2. Configure gcloud with your app id. + + ``` + gcloud config set project + ``` +1. Use the [Admin Console](https://appengine.google.com) to view data, queues, and other App Engine specific administration tasks. +1. Use gcloud to deploy your app. + + ``` + pip install -r requirements.txt -t lib/ + gcloud preview app deploy ./app.yaml + ``` + +1. Congratulations! Your application is now live at your-app-id.appspot.com + +## Contributing changes + +* See [CONTRIBUTING.md](../../../CONTRIBUTING.md) + +## Licensing + +* See [LICENSE](../../../LICENSE) diff --git a/datastore/ndb/transactions/app.yaml b/datastore/ndb/transactions/app.yaml new file mode 100644 index 000000000000..a71a3a86c341 --- /dev/null +++ b/datastore/ndb/transactions/app.yaml @@ -0,0 +1,18 @@ +# This file specifies your Python application's runtime configuration +# including URL routing, versions, static file uploads, etc. See +# https://developers.google.com/appengine/docs/python/config/appconfig +# for details. + +version: 1 +runtime: python27 +api_version: 1 +threadsafe: yes + +# Handlers define how to route requests to your application. +handlers: + +# This handler tells app engine how to route requests to a WSGI application. +# The script value is in the format . +# where is a WSGI application object. +- url: .* # This regex directs all routes to main.app + script: main.app diff --git a/datastore/ndb/transactions/appengine_config.py b/datastore/ndb/transactions/appengine_config.py new file mode 100644 index 000000000000..a51535059b2c --- /dev/null +++ b/datastore/ndb/transactions/appengine_config.py @@ -0,0 +1,11 @@ +""" +`appengine_config.py` is automatically loaded when Google App Engine +starts a new instance of your application. This runs before any +WSGI applications specified in app.yaml are loaded. +""" + +from google.appengine.ext import vendor + +# Third-party libraries are stored in "lib", vendoring will make +# sure that they are importable by the application. +vendor.add('lib') diff --git a/datastore/ndb/transactions/favicon.ico b/datastore/ndb/transactions/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..23c553a2966ca4cecf146093f33d8114b4f1e368 GIT binary patch literal 8348 zcmeI0du&tJ8Ng3Vwv|ewX4Hu@my&|vCD%DN@CLnxyptBT_%HjatoYr7%N3zGPed#@ckvA><;HWecDU4&2}*2(h%gm&WgCftWj zkQfW;&mXr@0S&(csd+cjaImbXSy=NC<10}z(efGwgi=;B$dt=HkKYCvp-#3KX+qIu zxx$>zcwk+N=c%1^J9)sO44lmS0##~wzU(43f>wW-p_YXwj>s>3{gHI*^oo1lmJ!X*bw{3UBAKRut zUh5Uy4_94IIkdxC^v{_g%FjuEI+f&;9KQ3i+nK7pU_RivFjP_DTl-&gP_qr$nD=M{ z@z;C3#y5Jsh77svGQ4u$ZX)t}=e52{#Xvk;4qIxNh86kR$OhCAie%&e`U{r{ACQZ@ z-)1#sItef{2L za&U;nm+_lo@lbR7vat&^EcECsH)uSnhlht@etsV4LE5B`j#GW*iur~}xpYlTtc;FC{nl|LK^miZ0y3WU>MIM zmc}94VzEFx9?#&?4l+h;ggzvOeCI$ob=`tBp*&EtirH2xU z4a#KB)IMa{_YdYrnxq>-DrrQ>rfpYe8@|Nc-oHnG*L(HR$}d4Eo2&X@o1~9l@%@W) zU{%rv$`tBAOHJH+?zcv7`!T~x;=<#7@4R5T^5$-%Pz-NAYt+5{d;>R+9W24y&`;ZkZqFGQ6_)<35Z_$5V#ga#=N9985-M0KR*fl@h4M0BxWvbYQr6t zULtYBAMJ%iU>x|?U8z_Zyv1jg_VcZ^kO)pd_)jk`_~2MHZmybbloW?l)lnMrb~TAX zV&%#e+VLvM4!%js+%B6}N!=udFlN5Jv;yQm0sdW({6ny+{{$_b`%pI&q3%#p3R?q( z%3@zpafPo4-GA}ErIfU@j?gpfdgeyI);;S-otz(GefQbXvG3J6hbwD_0*YOuqb1V8 zpQm{(oT|g$!tcw;Ck6l>=mo$z0J@0f0^U0{x?+mD8}QB{9yV7qQ;&$5^%*fb@qUB& zX(O<{D-aZ493K;1xH%!}9+}vt8Sshs4os9)d132glTa=lIJv}MJyU_Y!ZFl62j9@l zggg2y{y~c&Vm0cMa@}r@bbn?HR4Sa|66p;nlMl_6D%_%EjCNRq)NBvx!R!t`@zUoW zKV#O#EhZy4>~?VU+rfg@_W_4Kt~zS<|3JjVMcZ#exy;pDUypq|xjpD&0#H{BHgrvM zI=z9nnTN~NCX?mf@DOU;!82-#gXGsw5CSSf22lJ>u8duE&igGuZq4lVZf*LH2%QqOqkv@O{w`Y}q~yWm0EP zeSP~Hau49ZBU@&hWwH5YG0dnGVN1^iztQFh>rIvj5$iQ;q^nyuSuXo`U~{E8DpuIS zA{kR5oC9o=_>jhfRX@QTs1KRm{@F31 zFKP1!w?51@R^I~kA%H*B0W^sKnyVIsv`_2;=zbUGR9pOTqUhV{{^UH=RQ2@S?`uaQ zEy`)Gsd}1IEedW&4lAe0Sg5h`nQXqaZ}RyEzX{FT?hmF3>0_QQT1V~jI$wc&1@aZh ZS0G=3d706zJ{{SaIO|Jj| literal 0 HcmV?d00001 diff --git a/datastore/ndb/transactions/main.py b/datastore/ndb/transactions/main.py new file mode 100644 index 000000000000..5e6f230fb735 --- /dev/null +++ b/datastore/ndb/transactions/main.py @@ -0,0 +1,162 @@ +# Copyright 2015 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. + +import cgi +import flask +import random +import urllib +from google.appengine.ext import ndb + + +class Note(ndb.Model): + """Models an individual Note entry with content.""" + content = ndb.StringProperty() + + +def parent_key(page_name): + return ndb.Key("Parent", page_name) + + +app = flask.Flask(__name__) + + +@app.route('/') +def main_page(): + page_name = flask.request.args.get('page_name', 'default') + response = """ + +

Permenant note page: %s

""" % cgi.escape(page_name) + + parent = parent_key(page_name) + notes = Note.query(ancestor=parent).fetch(20) + for note in notes: + response += '

%s

' % cgi.escape(note.key.id()) + response += '
%s
' % cgi.escape(note.content) + + response += """ +
+
+ Submit Note:
+ +
""" % urllib.urlencode({'page_name': page_name}) + response += """ +
+
Switch page: +
+ + """ % cgi.escape(page_name, quote=True) + + return response + + +# [START standard] +@ndb.transactional +def insert_if_absent(note_key, note): + fetch = note_key.get() + if fetch is None: + note.put() + return True + return False +# [END standard] + + +# [START two-tries] +@ndb.transactional(retries=1) +def insert_if_absent_2_retries(note_key, note): + # [END two-tries] + fetch = note_key.get() + if fetch is None: + note.put() + return True + return False + + +# [START cross-group] +@ndb.transactional(xg=True) +def insert_if_absent_xg(note_key, note): + # [END cross-group] + fetch = note_key.get() + if fetch is None: + note.put() + return True + return False + + +# [START sometimes] +def insert_if_absent_sometimes(note_key, note): + # [END sometimes] + fetch = note_key.get() + if fetch is None: + note.put() + return True + return False + + +# [START indep] +@ndb.transactional(propagation=ndb.TransactionOptions.INDEPENDENT) +def insert_if_absent_indep(note_key, note): + # [END indep] + fetch = note_key.get() + if fetch is None: + note.put() + return True + return False + + +def pick_random_insert(note_key, note): + choice = random.randint(0, 4) + if choice == 0: + # [START calling2] + return insert_if_absent(note_key, note) + # [END calling2] + elif choice == 1: + return insert_if_absent_2_retries(note_key, note) + elif choice == 2: + return insert_if_absent_xg(note_key, note) + elif choice == 3: + # [START sometimes-call] + return ndb.transaction(lambda: insert_if_absent_sometimes(note_key, note)) + # [END sometimes-call] + elif choice == 4: + return insert_if_absent_indep(note_key, note) + + +@app.route('/add', methods=['POST']) +def add_note(): + page_name = flask.request.args.get('page_name', 'default') + note_title = flask.request.form['note_title'] + note_text = flask.request.form['note_text'] + + parent = parent_key(page_name) + + choice = random.randint(0, 1) + if choice == 0: + # Use transactional function + # [START calling] + note_key = ndb.Key(Note, note_title, parent=parent) + note = Note(key=note_key, content=note_text) + # [END calling] + if pick_random_insert(note_key, note) is False: + return 'Already there
Return' % flask.url_for('main_page', page_name=page_name) + return flask.redirect(flask.url_for('main_page', page_name=page_name)) + elif choice == 1: + # Use get_or_insert, which is transactional + note = Note.get_or_insert(note_title, parent=parent, content=note_text) + if note.content != note_text: + return 'Already there
Return' % flask.url_for('main_page', page_name=page_name) + return flask.redirect(flask.url_for('main_page', page_name=page_name)) + + +if __name__ == '__main__': + app.run() diff --git a/datastore/ndb/transactions/requirements.txt b/datastore/ndb/transactions/requirements.txt new file mode 100644 index 000000000000..a257e293a8b5 --- /dev/null +++ b/datastore/ndb/transactions/requirements.txt @@ -0,0 +1,7 @@ +# This requirements file lists all third-party dependencies for this project. +# +# Run 'pip install -r requirements.txt -t lib/' to install these dependencies +# in `lib/` subdirectory. +# +# Note: The `lib` directory is added to `sys.path` by `appengine_config.py`. +Flask==0.10 From 5d5a4026fb192ac289c0187d8ee088c1d83a0403 Mon Sep 17 00:00:00 2001 From: elibixby Date: Thu, 7 May 2015 12:57:25 -0700 Subject: [PATCH 2/3] Updated cloning instruction --- datastore/ndb/overview/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/datastore/ndb/overview/README.md b/datastore/ndb/overview/README.md index 098498d50b88..0d3142dfc9dc 100644 --- a/datastore/ndb/overview/README.md +++ b/datastore/ndb/overview/README.md @@ -20,8 +20,8 @@ scaffolding for other python frameworks and use cases. 1. Clone this repo. ``` - git clone https://github.com/GoogleCloudPlatform/datastore-pthon-samples.git - cd datastore-python-samples/ndb-overview + git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git + cd python-docs-samples/datastore/ndb/overview ``` 1. Run this project locally from the command line. From 346b54f670865449d57bffc3545047b8aa276c69 Mon Sep 17 00:00:00 2001 From: elibixby Date: Fri, 8 May 2015 11:11:03 -0700 Subject: [PATCH 3/3] Use single README for datastore --- datastore/ndb/CONTRIBUTING.md | 35 ----- datastore/ndb/LICENSE | 202 ------------------------- datastore/ndb/{overview => }/README.md | 8 +- datastore/ndb/modeling/README.md | 6 - datastore/ndb/tox.ini | 14 -- datastore/ndb/transactions/README.md | 61 -------- 6 files changed, 2 insertions(+), 324 deletions(-) delete mode 100644 datastore/ndb/CONTRIBUTING.md delete mode 100644 datastore/ndb/LICENSE rename datastore/ndb/{overview => }/README.md (87%) delete mode 100644 datastore/ndb/modeling/README.md delete mode 100644 datastore/ndb/tox.ini delete mode 100644 datastore/ndb/transactions/README.md diff --git a/datastore/ndb/CONTRIBUTING.md b/datastore/ndb/CONTRIBUTING.md deleted file mode 100644 index 6736efd943c8..000000000000 --- a/datastore/ndb/CONTRIBUTING.md +++ /dev/null @@ -1,35 +0,0 @@ -# How to become a contributor and submit your own code - -## Contributor License Agreements - -We'd love to accept your sample apps and patches! Before we can take them, we -have to jump a couple of legal hurdles. - -Please fill out either the individual or corporate Contributor License Agreement -(CLA). - - * 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] - (https://developers.google.com/open-source/cla/individual). - * If you work for a company that wants to allow you to contribute your work, - then you'll need to sign a [corporate CLA] - (https://developers.google.com/open-source/cla/corporate). - -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. - -## Contributing A Patch - -1. Submit an issue describing your proposed change to the repo in question. -1. The repo owner will respond to your issue promptly. -1. If your proposed change is accepted, and you haven't already done so, sign a - Contributor License Agreement (see details above). -1. Fork the desired repo, develop and test your code changes. -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. -1. Ensure that your code has an appropriate set of unit tests which all pass. -1. Submit a pull request. diff --git a/datastore/ndb/LICENSE b/datastore/ndb/LICENSE deleted file mode 100644 index 4f73028109b8..000000000000 --- a/datastore/ndb/LICENSE +++ /dev/null @@ -1,202 +0,0 @@ -Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - 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. - diff --git a/datastore/ndb/overview/README.md b/datastore/ndb/README.md similarity index 87% rename from datastore/ndb/overview/README.md rename to datastore/ndb/README.md index b4be476fbf08..56a14bb36325 100644 --- a/datastore/ndb/overview/README.md +++ b/datastore/ndb/README.md @@ -20,14 +20,10 @@ scaffolding for other python frameworks and use cases. 1. Clone this repo. ``` -<<<<<<< HEAD git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git - cd python-docs-samples/datastore/ndb/overview -======= - git clone https://github.com/GoogleCloudPlatform/datastore-pthon-samples.git - cd datastore-python-samples/ndb-overview ->>>>>>> 23fb0ab7babac042c09d45ae61bb112322049f74 + cd python-docs-samples/datastore/ndb/ ``` + 1. Run this project locally from the command line. ``` diff --git a/datastore/ndb/modeling/README.md b/datastore/ndb/modeling/README.md deleted file mode 100644 index 47d01fb9ed53..000000000000 --- a/datastore/ndb/modeling/README.md +++ /dev/null @@ -1,6 +0,0 @@ -appengine-ndb-snippets -====================== - -= modeling - -Sample code for (Modeling Entity Relationships)[https://cloud.google.com/appengine/articles/modeling]. diff --git a/datastore/ndb/tox.ini b/datastore/ndb/tox.ini deleted file mode 100644 index 9a17a256173c..000000000000 --- a/datastore/ndb/tox.ini +++ /dev/null @@ -1,14 +0,0 @@ -[tox] -skipsdist = True -envlist = flake8-py2.7,py2.7 - -[testenv:flake8-py2.7] -deps = flake8 -commands = flake8 modeling - -[testenv:py2.7] -deps = - nose - nosegae -commands = - nosetests --with-gae modeling diff --git a/datastore/ndb/transactions/README.md b/datastore/ndb/transactions/README.md deleted file mode 100644 index 39c983ae0aca..000000000000 --- a/datastore/ndb/transactions/README.md +++ /dev/null @@ -1,61 +0,0 @@ -## NDB Transactions Sample - -This is a sample app for Google App Engine that exercises the [NDB Transactions Python API](https://cloud-dot-devsite.googleplex.com/appengine/docs/python/ndb/transactions) - -This app presents a list of notes. After you submit a note with a particular title, you may not change that note or submit a new note with the same title. There are multiple note pages available. - -See our other [Google Cloud Platform github -repos](https://github.com/GoogleCloudPlatform) for sample applications and -scaffolding for other python frameworks and use cases. - -## Run Locally -1. Install the [Google Cloud SDK](https://cloud.google.com/sdk/), including the [gcloud tool](https://cloud.google.com/sdk/gcloud/), and [gcloud app component](https://cloud.google.com/sdk/gcloud-app). -2. Setup the gcloud tool. - - ``` - gcloud components update app - gcloud auth login - gcloud config set project - ``` - You don't need a valid app-id to run locally, but will need a valid id to deploy below. - -1. Clone this repo. - - ``` - git clone https://github.com/GoogleCloudPlatform/datastore-samples.git - cd datastore-samples/python/ndb/transactions - ``` -1. Run this project locally from the command line. - - ``` - pip install -r requirements.txt -t lib/ - gcloud preview app run ./app.yaml - ``` - -1. Visit the application at [http://localhost:8080](http://localhost:8080). - -## Deploying - -1. Use the [Cloud Developer Console](https://console.developer.google.com) to create a project/app id. (App id and project id are identical) -2. Configure gcloud with your app id. - - ``` - gcloud config set project - ``` -1. Use the [Admin Console](https://appengine.google.com) to view data, queues, and other App Engine specific administration tasks. -1. Use gcloud to deploy your app. - - ``` - pip install -r requirements.txt -t lib/ - gcloud preview app deploy ./app.yaml - ``` - -1. Congratulations! Your application is now live at your-app-id.appspot.com - -## Contributing changes - -* See [CONTRIBUTING.md](../../../CONTRIBUTING.md) - -## Licensing - -* See [LICENSE](../../../LICENSE)