Metadata-Version: 1.0
Name: django-shop-simplenotifications
Version: 0.1.2
Summary: A simple reusable app for django-shop that sends emailnotifications on certain events
Home-page: https://github.com/bitmazk/django-shop-simplenotifications
Author: Martin Brochhaus
Author-email: martin.brochhaus@gmail.com
License: BSD License
Description: django-shop-simplenotifications
        ================================
        
        Only use this, if you are brave!
        
        This is a dead simple approach on email notifications for django-shop. The
        goal of this app is to hook into django-shop's various signals in order to 
        send emails to the shop owner and to the buyer on certain events.
        
        Installation
        =============
        
        Install this package into your virtualenv::
        
          pip install django-shop-simplenotifications 
        
        Add the app to your INSTALLED_APPS setting::
        
          INSTALLED_APPS = (
              ...
              'shop_simplenotifications',
          )
        
        Configuration
        ==============
        
        SN_FROM_EMAIL
        ++++++++++++++
        
        Default: DEFAULT_FROM_EMAIL
        
        The from address for your automated emails. Example::
        
          SN_EMAIL_FROM = 'noreply@myshop.com'
        
        SN_OWNERS
        ++++++++++
        
        Default: ADMINS
        
        A tuple that lists people who get notifications about new incoming orders and
        payments. Each member of the tuple should be a tuple of
        (Full name, email address). Example::
        
          (('John', 'john@example.com'), ('Mary', 'mary@example.com'))
        
        Templates
        ==========
        
        In order to easily provide notifications with the wording and formatting of
        your choice, there are templates for all email subjects and bodies. In order
        to override the defaults, add the folowing templates to your
        ``templates/shop_simplenotifications/`` folder:
        
          * confirmed_subject.html
          * confirmed_body.html
          * payment_instructions_subject.html
          * payment_instructions_body.html
        
        All templates have a ``request`` and an ``order`` variable in their context.
        
        Features
        =========
        
          * When a buyer completes his order, the shop owners get a notification mail
          * All notification emails can be easily templated.
        
        Testing
        ========
        
        If you want to contribute to this project and quickly need to run the
        test-suite, you need to do the following steps:
        
          * create a virtual environment
          * fork this repository
          * install this package into your virtual environment
          * manually install the django-shop dependency (this step will be gone soon)
          * execute ``runtests.py``
        
        Example::
        
          mkvirtualenv -p python2.7 yourenvname
          workon yourenvname
          git clone git://github.com/bitmazk/django-shop-simplenotifications.git
          cd django-shop-simplenotifications
          python setup.py install
          pip install -e git+git://github.com/divio/django-shop.git#egg=shop
          cd shop_simplenotifications/tests
          ./runtests.py
        
Keywords: django,django-shop,email,notifications
Platform: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
