Index: appengine/findit/gae_libs/README.md |
diff --git a/appengine/findit/gae_libs/README.md b/appengine/findit/gae_libs/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..67915c28a03666e6a5fd59cd0b8ff8b7ed679cef |
--- /dev/null |
+++ b/appengine/findit/gae_libs/README.md |
@@ -0,0 +1,17 @@ |
+# gae_libs |
+ |
+This [gae\_libs](gae_libs) module is for shared code that depends on App Engine |
+APIs (gae is short for Google App Engine), eg: an NDB model that supports |
wrengr
2016/11/15 00:38:00
The proper spelling is "e.g.,"
stgao
2016/11/16 18:44:10
Done. Thanks for the correction :)
|
+keeping multiple versions of the same information like configuration. |
+ |
+It also depends on the sibling [libs](libs) module, and provides gae wrappers |
+for the code there, eg: a Gitiles client with data cached in memcache on App |
+Engine. |
+ |
+# How to use? |
+ |
+Create symbolic links to both [gae\_libs](gae_libs) and [libs](libs) in the same |
+containing directory, and ensure that the containing directory is in sys.path or |
wrengr
2016/11/15 00:38:00
"containing directory" is non-idomatic. Should be
stgao
2016/11/16 18:44:10
It doesn't have to be in the root direction of tha
|
+PYTHONPATH. |
+ |
+The usage would look like: `from gae_libs import API_MODULE_NAME` |