app/README
author Todd Larsen <tlarsen@google.com>
Tue, 16 Sep 2008 16:42:55 +0000
changeset 153 79d52c2d50a2
child 1502 2fee94feef59
permissions -rw-r--r--
Add README files to explain how third-party code is maintained in these directories.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
153
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     1
trunk/app should contain only the files needed for the actual Google App
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     2
Engine application "image".  Support code that is not part of the application
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     3
image belongs elsewhere, such as in trunk/scripts, for example.
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     4
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     5
= THIRD PARTY CODE =
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     6
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     7
Third-party code that is *not* part of the application image (the Google App
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     8
Engine SDK in trunk/thirdparty/google_appengine, for example) belongs in
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
     9
trunk/thirdparty (see also trunk/thirdparty/README).
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    10
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    11
Third-party code that is part of the application image is placed in a package
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    12
subdirectory in trunk/app, such as trunk/app/django, for example.
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    13
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    14
If the third-party package is a single Python source file, place the code in
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    15
trunk/app/<package>/__init__.py, so that it can simply be imported using,
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    16
for example:
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    17
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    18
import feedparser
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    19
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    20
(The trunk/app/feedparser package is a good example of this approach.)
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    21
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    22
== THIRD PARTY LICENSES ==
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    23
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    24
Third-party code must also include a license text file, named LICENSE or
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    25
COPYING, in the package subdirectory.  If the third-party package subdirectory
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    26
is maintained automatically with a tool such as svn_load_dirs.pl (which
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    27
removes files, such as license text files, that were added later to the
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    28
"target" directory), place the license text file in the trunk/app directory
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    29
and add the package name as a suffix (LICENSE.django is an example of this
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    30
case).
79d52c2d50a2 Add README files to explain how third-party code is maintained in these
Todd Larsen <tlarsen@google.com>
parents:
diff changeset
    31