Author: leidel
Date: Sun Jan 11 17:31:38 2009
New Revision: 53
Added:
trunk/AUTHORS
trunk/LICENSE
trunk/MANIFEST.in
trunk/README
- copied, changed from r49, /trunk/mailerdev/README
trunk/setup.py
Log:
Added files for packaging
Added: trunk/AUTHORS
==============================================================================
--- (empty file)
+++ trunk/AUTHORS Sun Jan 11 17:31:38 2009
@@ -0,0 +1,11 @@
+
+The PRIMARY AUTHORS are:
+
+ * James Tauber
+ * Brian Rosner
+
+ADDITIONAL CONTRIBUTORS include:
+
+ * Michael Trier
+ * Doug Napoleone
+ * Jannis Leidel
Added: trunk/LICENSE
==============================================================================
--- (empty file)
+++ trunk/LICENSE Sun Jan 11 17:31:38 2009
@@ -0,0 +1,22 @@
+Copyright (c) 2009 James Tauber and contributors
+
+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.
\ No newline at end of file
Added: trunk/MANIFEST.in
==============================================================================
--- (empty file)
+++ trunk/MANIFEST.in Sun Jan 11 17:31:38 2009
@@ -0,0 +1,3 @@
+include AUTHORS
+include LICENSE
+recursive-include docs *
Copied: trunk/README (from r49, /trunk/mailerdev/README)
==============================================================================
--- /trunk/mailerdev/README (original)
+++ trunk/README Sun Jan 11 17:31:38 2009
@@ -1,38 +1,26 @@
django-mailer by James Tauber <http://jtauber.com/>
http://code.google.com/p/django-mailer/
+A reusable Django app for queuing and throttling of email sending,
scheduled
+sending, consolidation of multiple notifications into single emails and
+logging of mail failures.
-TO SEE DEMO IN ACTION
-(you might want to comment out the call to core_send_mail in engine.py
first)
-
-1. `python manage.py syncdb` and create superuser for admin
-
-2. `python manage.py loaddata test1` to load some test data from a fixture
-
-3. `python manage.py runserver` to fire up the development server
-
-4. go to http://localhost:8000/admin/ and check out the mailer models
-
-5. open a separate shell and run `python manage.py shell`
-
-6. at the interactive prompt, type `from mailer.engine import send_loop`
-
-7. start the send loop with `send_loop()`
-
- You will see four mail sends are simulated and one is skipped because
- the addressee is on the don't send list.
-
- The loop will then sleep for (by default) 30 seconds before checking
- the queue again. It will continue this indefinitely.
-
-8. with the send loop still running, go back to the django admin console
-
-9. notice that the message model is now empty and the messages have moved
- to the message log model
-
-10. add a new message (the addresses don't matter if you commented out the
- call to core_send_mail in engine.py)
-
- Watch the interactive console and, within the sleep period, you should
- see the message you added picked up and a send simulated.
+Sample Use Cases
+* a site admin wants to send a one-off announcement to all users on a site
+* a site admin wants to send a one-off email to a subset of users (e.g.
thank
+ you note to users who completed a survey)
+* a site admin wants to send an email but wants to defer it to a particular
+ date or time (e.g. send out at 9am tomorrow a reminder of the scheduled
+ downtime at 10am)
+* a site admin wants to send a regular email to a subset of users (e.g.
+ people who haven't logged in for over a month)
+* a user wants email notification when certain events specific to them
happen
+ (e.g. a friend accepts their invitation to join a group, they receive a
+ private message)
+* a user wants email notification when certain events relevant to a subset
of
+ users happen (e.g. there has been a reply to a message board thread or
blog
+ entry that the user has subscribed to)
+* a user doesn't want individual emails for each notification but wants
them
+ in digest form (e.g. a daily digest of new posts or a weekly update on
+ friends who have joined)
\ No newline at end of file
Added: trunk/setup.py
==============================================================================
--- (empty file)
+++ trunk/setup.py Sun Jan 11 17:31:38 2009
@@ -0,0 +1,26 @@
+from distutils.core import setup
+
+setup(
+ name='django-mailer',
+ version=__import__('mailer').__version__,
+ description='Mail queuing and management for the Django web
framework.',
+ long_description=open('docs/usage.txt').read(),
+ author='James Tauber',
+ author_email='[email protected]',
+ url='http://code.google.com/p/django-mailer/',
+ packages=[
+ 'notification',
+ 'notification.management',
+ 'notification.management.commands',
+ ],
+ package_dir={'mailer': 'mailer'},
+ classifiers=[
+ 'Development Status :: 3 - Alpha',
+ 'Environment :: Web Environment',
+ 'Intended Audience :: Developers',
+ 'License :: OSI Approved :: MIT License',
+ 'Operating System :: OS Independent',
+ 'Programming Language :: Python',
+ 'Framework :: Django',
+ ]
+)
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"pinax-updates" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/pinax-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
