Metadata-Version: 1.1
Name: async-notifications
Version: 0.1.9
Summary: Email async notifications with celery.
Home-page: https://github.com/luisza/async_notifications
Author: Luis Zarate Montero
Author-email: luis.zarate@solvosoft.com
License: GNU General Public License
Description: Async notifications
        =====================
        
        Email notification with celery and administrative view for send email with delay e.g daily
        
        Features
        ---------
        
        - Celery integration
        - Administrative view 
        - Enqueued mail system and instantly send
        - Problems notification
        - User filter email
        - Template system with template context
        - Send to User, Group or external email
        - Django cms integration (djcms_async_notifications) and standalone.
        - Custom text area widget support
        - Allow send group mail list if it's defined.
        
        
        Installation
        =============
        
        #. Install from pip 
        
            .. code:: bash
            
                $ pip install async_notifications
        
        #. Add required apps in your settings **
        
            .. code:: python
        
                INSTALLED_APPS = [
                    ...
                    'ajax_select',
                    'async_notifications'
                ]
        
        #. Add ajax_select urls in urls.py
        
            .. code:: python
        
                from django.conf.urls import url, include
                from ajax_select import urls as ajax_select_urls
                urlpatterns = [
                    ...
                    url(r'^ajax_select/', include(ajax_select_urls)),
                ]
           
        #. It's really important set *CELERY_MODULE* pointing to your project celery file, because it's needed for assing task to the current project, and configure some default celery options
        
            .. code:: python
        
                # settings.py
                CELERY_MODULE = "demo.celery"
                CELERY_TIMEZONE = TIME_ZONE
                CELERY_ACCEPT_CONTENT = ['pickle', 'json']
                
        
        
        #. Configure your email settings, e.g for development
        
            .. code:: python
            
                DEFAULT_FROM_EMAIL="mail@example.com"
                EMAIL_HOST="localhost"
                EMAIL_PORT="1025"
        
        # Copy celery app in your project folder from demo, and adjust the crontab execution
        
            .. code:: python
        
                # celery.py
                app.conf.CELERYBEAT_SCHEDULE = {
                    # execute 12:30 pm
                    'send_daily_emails': {
                        'task': 'async_notifications.tasks.send_daily',
                        'schedule': crontab(minute=30, hour=0),
        
                    },
                }
        
        Remember use  demo/__init__.py to update your projectfolder/__init__.py.
        
        #. Run migrations 
        
            .. code:: bash
            
                $ python manage.py migrate
        
        
        Runing the project
        ===================
        
        You need to run 3 subsystems for run this app so you need 3 xterm, for this explanation I will use the demo project
        
        1. Run smtp debug client
        
            .. code:: bash
            
                $ python -m smtpd -n -c DebuggingServer localhost:1025 
        
        2. Run celery, if you aren't setup celery yet see `celery documentation <http://docs.celeryproject.org/en/latest/django/first-steps-with-django.html>`_.
        
            .. code:: bash
        
                $ celery -A demo worker -l info -B
                
        3. Run django
        
            .. code:: bash
            
                $ python manage.py runserver
        
        Usage
        =========
        
        Report your context template 
        
        .. code:: python
        
            from async_notifications.register import update_template_context
            context = [
                ('fieldname', 'Field description'),
                ('fieldname2', 'Field description'),
                ...
            ]
            update_template_context("yourcode",  'your email subject', context )
        
        This automátically create a Email template if not found. 
        
        Context is list of tuples with the fields available in the template context, this context is add in the same file 
        that have `send_email_from_template`
        
        
        Send an email :) 
        
        .. code:: python
        
            send_email_from_template(code, recipient,
                                     context={},
                                     enqueued=True,
                                     user=None,
                                     upfile=None)
        
        Params description:
        
        - `recipient` is a list of emails
        - `code` is the same code register in update_template_context
        - `enqueued`  if **False** send the email immediately else enqueued to be sended when send email task run.
        - `user` user how send email
        - `upfile` attached file in email
        
        Other optional options 
        ========================
        
        Adding context dummy object
        ----------------------------
        
        When you need to pass a default template message base on template, but you have not the template object
        and also you need to write the object with django template sintaxis you can use DummyContextObject that 
        return always something like {{ myobj.attr1.objattr }}
            
        .. code:: python
        
            from async_notifications.register import update_template_context, DummyContextObject
            context = [
                ('myobj', 'Field description'),
                ...
            ]
            message = render_to_string('some/template.html',
                                   context={
                                       'myobj': DummyContextObject('myobj')
                                   }
                                   )
            update_template_context("yourcode",  'your email subject', context, message=message )
        
        
        Django cms integration
        -------------------------
        
        This configuration could help you to integrate with Django CMS.
        
        include in your `INSTALLED_APPS`:
        
        .. code:: python
        
            INSTALLED_APPS = [
                ...
              'async_notifications',
              'async_notifications.djcms_async_notifications',
            ]
        
        Configure how models and field async_notifications will use, ej. aldryn_people
        
        .. code:: python
        
            ASYNC_NOTIFICATION_GROUP = 'aldryn_people.Group'
            ASYNC_NOTIFICATION_GROUP_LOOKUP_FIELDS = {
                'order_by': 'translations__name',
                'email': 'email',
                'group_lookup': 'translations__name',
                'display': 'name',
                'filter': ['translations__name__icontains']}
        
        
            ASYNC_NOTIFICATION_USER = 'aldryn_people.Person'
        
            ASYNC_NOTIFICATION_USER_LOOKUP_FIELDS = {
                'order_by': 'translations__name',
                'display': 'name',
                'filter': [
                    'user__first_name__icontains',
                    'user__last_name__icontains',
                    'translations__name__icontains'],
                'group_lookup': 'groups__translations__name'}
        
        .. note:: Django auth is used by default
        
        cmsplugin-contact-plus
        -------------------------
        
        CONTACT_PLUS_SEND_METHOD = 'async_notifications.djcms_async_notifications.contact_plus.send_email'
        ASYNC_NOTIFICATION_CONTACT_PLUS_EMAIL = 'email'
        
        .. note:: 
        
            This requires special cmsplugin-contact-plus version, we send a PRs, but is not merged yet.
        
        Default text area widget
        --------------------------
        
        For example using ckeditor widget
        
        ASYNC_NOTIFICATION_TEXT_AREA_WIDGET = 'ckeditor.widgets.CKEditorWidget'
        
        .. note:: 
            See how to configure `CKEditor <https://github.com/django-ckeditor/django-ckeditor>`_ .
        
        
Platform: OS Independent
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
