From ae14afbd2d8c921c1cfa3c5650f5496de6b9d28b Mon Sep 17 00:00:00 2001 From: Alex Dehnert Date: Sat, 30 Nov 2013 01:36:07 -0500 Subject: [PATCH] Move Django docs up a level, to ease subtree merging --- django/{mit => }/COPYING | 0 django/README | 18 ++++++++++++++++++ django/mit/README | 17 ----------------- 3 files changed, 18 insertions(+), 17 deletions(-) rename django/{mit => }/COPYING (100%) create mode 100644 django/README delete mode 100644 django/mit/README diff --git a/django/mit/COPYING b/django/COPYING similarity index 100% rename from django/mit/COPYING rename to django/COPYING diff --git a/django/README b/django/README new file mode 100644 index 0000000..5975e8d --- /dev/null +++ b/django/README @@ -0,0 +1,18 @@ +/mit/__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 the "mit" directory into +your project, add it to your apps list, and modify your middlewares and auth +backend appropriately. Do *not* link this (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. diff --git a/django/mit/README b/django/mit/README deleted file mode 100644 index 8271dac..0000000 --- a/django/mit/README +++ /dev/null @@ -1,17 +0,0 @@ -__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. -- 2.44.0