summaryrefslogtreecommitdiffstats
path: root/python/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/README')
-rw-r--r--python/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/python/README b/python/README
new file mode 100644
index 000000000..f9e677b5e
--- /dev/null
+++ b/python/README
@@ -0,0 +1,21 @@
+This directory contains common Python code.
+
+The basic rule is that if Python code is cross-module (that's "module" in the
+Mozilla meaning - as in "module ownership") and is MPL-compatible, it should
+go here.
+
+What should not go here:
+
+* Python that is not MPL-compatible (see other-licenses/)
+* Python that has good reason to remain close to its "owning" (Mozilla)
+ module (e.g. it is only being consumed from there).
+
+Historical information can be found at
+https://bugzilla.mozilla.org/show_bug.cgi?id=775243
+
+## pyyaml | pystache
+
+Used in taskcluster related mach commands to update download from github
+and remove .git and tests.
+
+Then run tests in taskcluster/tests/