[Findit] Re-org code.

appengine/findit/infra_clients/README.md

Index: appengine/findit/infra_clients/README.md
diff --git a/appengine/findit/infra_clients/README.md b/appengine/findit/infra_clients/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..564d2507d985691693a29e839812e5d4c65cac7b
--- /dev/null
+++ b/appengine/findit/infra_clients/README.md
@@ -0,0 +1,15 @@
+# infra_clients
+
+This [infra\_clients](infra_clients) module is for client code that interacts

[wrengr, 2016/11/15 00:38:01]

s/^This /The /

[wrengr, 2016/11/15 00:38:01]

I don't think "client code" is clear. In programming more generally "client"
could be any code using those various APIs (so calling the code here "client"
code isn't terribly helpful, since we're not looking at things from the
perspective of those libraries). But "client" is also used as a technical name
for AppEngine applications (so it's not clear whether that's what is meant here,
or not).

Also "infra_clients" isn't a good name. In addition to the problems with
"client" mentioned above, there are no actual clients in this directory (as the
name suggests there should be)! Since the only thing in here is the codereview
directory, why not mode that to ./libs/codereview? Or ./gae_libs/codereview (if
it's AppEngine-dependent)? Or if you really want a third directory then you
should use ./${SOMETHING}_libs/codereview for consistency. (I'd suggest against
"infra_libs" as that's too ambiguous. We're in the infra repo, so that could be
*everything*.)

[stgao, 2016/11/16 18:44:11]

I agree "client code" is misleading here. I changed it to "client libraries" to
match the case here.
https://cloud.google.com/appengine/docs/python/endpoints/gen_clients

"client" is actually good here. With web service APIs (like the infra service
here), the code module encapsulated to talk to those APIs on the user
application side could be conceptually named client of those APIs. And this is
pretty common from my experience.

Basically, there are two types of client "service client" (from perspective of
deployment) and "service api client" (from perspective of code). Here is the
later.
I changed it to "infra_api_clients" to be more specific. "infra_libs" is
terrible in this case, and that's the reason I didn't use to match libs/ or
gae_libs/.
This folder is specific for code that talks to infra service, and there are a
few more others like buildbucket, buildbot, swarming, isolate, etc.

[stgao, 2016/11/16 18:44:11]

Done.

+with APIs of various infra services like buildbucket, Swarming/Isolate, Reitveld
+codereview, etc.
+
+It depends on the sibling [libs](libs) and [gae\_libs](gae_libs).
+
+# How to use?
+
+Create symbolic links to [infra\_clients](infra_clients), [gae\_libs](gae_libs)
+and [libs](libs) in the same containing directory, and ensure that the
+containing directory is in sys.path or PYTHONPATH.
+
+The usage would look like: `from infra_clients import INFRA_SERVICE_API`