Metadata-Version: 1.0
Name: django-writeback
Version: 0.1.10
Summary: A pluggable customizable Django app to collect feedback from site visitors.
Home-page: https://github.com/timgin/django-writeback/
Author: Timour Ghinatoulline
Author-email: tim@plusone.su
License: BSD License
Description: Writeback
        =========
        
        Writeback is a pluggable customizable Django app to collect feedback from site visitors using AJAX.
        
        Installation
        ------------
        
        Install using pip::
        
            pip install django-writeback
        
        Quick start
        -----------
        
        + Add "writeback" to your INSTALLED_APPS setting like this::
        
                INSTALLED_APPS += ('writeback', )
        
        + Add context processor to your TEMPLATE_CONTEXT_PROCESSORS setting like this::
        
                TEMPLATE_CONTEXT_PROCESSORS += ('writeback.context.add_form', )
        
        + Specify email settings WRITEBACK_EMAIL_NOTIFICATION_SUBJECT, WRITEBACK_EMAIL_NOTIFICATION_FROM and WRITEBACK_EMAIL_NOTIFICATION_TO_LIST. These will be used in email notifications.
        
        + Run ``python manage.py syncdb`` to synchronize the database.
        
        + Run ``python manage.py collectstatic`` or ``python manage.py collectstatic -i admin``, if you want to omit collecting static for the admin app.
        
        + Include the writeback URLconf in your project urls.py like this::
        
                url(r'^writeback/', include('writeback.urls')),
        
        + Modify your base template::
        
                <!-- in header block -->
                {% include "writeback/header.html" %}
                
                <!-- in body block -->
                {% include "writeback/button.html" %}
        
        + Override ``email_notification.html`` and ``button.html`` templates.
        
        Model customization
        -------------------
        
        The ``Message`` model, which is used for collecting feedback, can be extended:
        
        + Create an app, for example ``custom_writeback`` with a file, which shall contain class declaration, name it, ``classes.py``, for example.
        
        + Add this newly created app to your ``INSTALLED_APPS`` setting like this::
        
                INSTALLED_APPS += ('custom_writeback', )
        
        + Declare your model class, inheriting from ``writeback.models.EventAbstract``::
        
                from events.models import EventAbstract
        
        
                class MyEventAbstract(EventAbstract):
                    # define your custom fields
        
                    class Meta(EventAbstract.Meta):
                        abstract = True
        
        + Register your class in the project's ``settings.py``::
        
                EVENTS_EVENT_BASE_MODEL = 'custom_events.models.MyEventAbstract'
        
        
Keywords: blog,django,feedback,ajax,user,customer,comment
Platform: UNKNOWN
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: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
