Add README and COPYING for django/mit/
authorAlex Dehnert <adehnert@mit.edu>
Mon, 6 Jun 2011 06:56:19 +0000 (02:56 -0400)
committerAlex Dehnert <adehnert@mit.edu>
Mon, 6 Jun 2011 06:56:19 +0000 (02:56 -0400)
As mentioned in the README, this is derived from code for the Remit
(https://remit.scripts.mit.edu/trac/) and the ASA DB
(https://asa.scripts.mit.edu/trac/). If you see bug numbers in the history,
they're probably from Remit (https://remit.scripts.mit.edu/trac/query).
Hopefully these can be useful to somebody else.

django/mit/COPYING [new file with mode: 0644]
django/mit/README [new file with mode: 0644]

diff --git a/django/mit/COPYING b/django/mit/COPYING
new file mode 100644 (file)
index 0000000..682a399
--- /dev/null
@@ -0,0 +1,19 @@
+Copyright (C) 2010--2011 by Alex Dehnert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/django/mit/README b/django/mit/README
new file mode 100644 (file)
index 0000000..8271dac
--- /dev/null
@@ -0,0 +1,17 @@
+__init__.py contains some useful functionality for Django applications running
+at MIT, particularly on the scripts.mit.edu platform
+* zephyr(msg, clas, instance, rcpt) sends a zephyr (by shelling out to zwrite).
+  This may be useful for debugging or logging
+* ScriptsRemoteUserMiddleware and ScriptsRemoteUserBackend work together to
+  auto-create users from certificates on scripts.mit.edu-hosted sites. Account
+  details are automatically retrieved from LDAP.
+* scripts_login is a view that tries to log users into a site using certs.
+
+To use them, you'll probably want to symlink or copy this directory ("mit")
+into your project, add it to your apps list, and modify your middlewares and
+auth backend appropriately. Do *not* link the django directory into your app;
+it's reasonably likely to break your "import django.foo" statements.
+
+This code is descended from work on Remit (https://remit.scripts.mit.edu/trac/)
+and the ASA DB (https://asa.scripts.mit.edu/trac/); current and past bugs are
+likely to be filed there.