Metadata-Version: 1.1
Name: django-tables2-reports
Version: 0.0.7
Summary: With django-tables2-reports you can get a report (CSV, XLS) of any django-tables2 with minimal changes to your project
Home-page: https://github.com/goinnn/django-tables2-reports
Author: Pablo Martin
Author-email: goinnn@gmail.com
License: LGPL 3
Description: .. contents::
        
        =====================
        Django tables2 report
        =====================
        
        .. image:: https://badge.fury.io/py/django-tables2-reports.png
            :target: https://badge.fury.io/py/django-tables2-reports
        
        .. image:: https://pypip.in/d/django-tables2-reports/badge.png
            :target: https://pypi.python.org/pypi/django-tables2-reports
        
        With django-tables2-reports you can get a report (CSV, XLS) of any `table <http://pypi.python.org/pypi/django-tables2/>`_  with **minimal changes** to your project
        
        Requeriments
        ============
        
        * `django-tables2 <http://pypi.python.org/pypi/django-tables2/>`_ (>=0.11.0, tested to 0.13.0 and 0.14.0)
        * `xlwt <http://pypi.python.org/pypi/xlwt/>`_ or `pyExcelerator <http://pypi.python.org/pypi/pyExcelerator/>`_ (>=0.6.4a) or  (>=7.2) (These are optionals, to export to xls. Default to xlwt if available)
        
        If you use python3, and you want export to xls use this version of the `xlwt (fork) <https://github.com/edschofield/xlwt/>`_ if this `pull request <https://github.com/python-excel/xlwt/pull/32>`_ is not merged still.
        
        
        Installation
        ============
        
        * In your settings:
        
        ::
        
            INSTALLED_APPS = (
        
                'django_tables2_reports',
            )
        
        
            TEMPLATE_CONTEXT_PROCESSORS = (
        
                'django.core.context_processors.static',
        
            )
        
        Changes in your project
        =======================
        
        1. Now your table should extend of 'TableReport'
        
        ::
        
            ############### Before ###################
        
            import django_tables2 as tables
        
        
            class MyTable(tables.Table):
        
                ...
        
            ############### Now ######################
        
            from django_tables2_reports.tables import TableReport
        
        
            class MyTable(TableReport):
        
                ...
        
        
        2.a. If you use a traditional views, now you should use other RequestConfig and change a little your view:
        
        ::
        
            ############### Before ###################
        
            from django_tables2 import RequestConfig
        
        
            def my_view(request):
                objs = ....
                table = MyTable(objs)
                RequestConfig(request).configure(table)
                return render_to_response('app1/my_view.html',
                                          {'table': table},
                                          context_instance=RequestContext(request))
        
            ############### Now ######################
        
            from django_tables2_reports.config import RequestConfigReport as RequestConfig
            from django_tables2_reports.utils import create_report_http_response
        
            def my_view(request):
                objs = ....
                table = MyTable(objs)
                table_to_report = RequestConfig(request).configure(table)
                if table_to_report:
                    return create_report_http_response(table_to_report, request)
                return render_to_response('app1/my_view.html',
                                          {'table': table},
                                          context_instance=RequestContext(request))
        
        
        If you have a lot of tables in your project, you can activate the middleware, and you do not have to change your views, only the RequestConfig import
        
        ::
        
            # In your settings 
        
            MIDDLEWARE_CLASSES = (
        
                'django_tables2_reports.middleware.TableReportMiddleware',
            )
        
            ############### Now (with middleware) ######################
        
            from django_tables2_reports.config import RequestConfigReport as RequestConfig
        
            def my_view(request):
                objs = ....
                table = MyTable(objs)
                RequestConfig(request).configure(table)
                return render_to_response('app1/my_view.html',
                                          {'table': table},
                                          context_instance=RequestContext(request))
        
        
        2.b. If you use a `Class-based views <https://docs.djangoproject.com/en/dev/topics/class-based-views/>`_:
        
        ::
        
            ############### Before ###################
        
            from django_tables2.views import SingleTableView
        
        
            class PhaseChangeView(SingleTableView):
                table_class = MyTable
                model = MyModel
        
        
            ############### Now ######################
        
            from django_tables2_reports.views import ReportTableView
        
        
            class PhaseChangeView(ReportTableView):
                table_class = MyTable
                model = MyModel
        
        
        Usage
        =====
        
        Under the table appear a CSV icon (and XLS icon if you have xlwt or pyExcelerator in your python path), if you click in this icon, you get a CSV report (or xls report) with every item of the table (without pagination). The ordering works!
        
        
        
        Releases
        ========
        
        0.0.7 (2013-08-29)
        ------------------
        
        * Russian translations
        * Thanks to:
            * `Armicron <https://github.com/armicron>`_
        
        
        0.0.6  (2013-08-22)
        -------------------
        
        * Python3 support
        * Polish translation
        * Thanks to:
            * `Michał Pasternak <https://github.com/mpasternak>`_
        
        0.0.5  (2013-07-03)
        -------------------
        
        * Improvements in the README
        * Exportable to XLS with `xlwt <http://pypi.python.org/pypi/xlwt/>`_
        * Thanks to:
            * `Crashy23 <https://github.com/Crashy23>`_
            * `Gamesbook <https://github.com/gamesbook>`_
            * And spatially to `Austin Phillips <https://github.com/austinphillips2>`_
        
        
        0.0.4  (2013-05-17)
        -------------------
        
        * Escape csv data correctly during output
        * The fields with commas now are not split into multiple columns
        * Thanks to:
            * `Austin Phillips <https://github.com/austinphillips2>`_
        
        0.0.3  (2012-07-19)
        -------------------
        
        * Fix a little error, when a column has line breaks. Now these are changed to espaces
        * Details
        
        0.0.2  (2012-07-18)
        -------------------
        
        * Add a default view (https://docs.djangoproject.com/en/dev/topics/class-based-views/)
        * Exportable to XLS
        * Update the README
        
        0.0.1  (2012-07-17)
        -------------------
        
        * Initial release
        
Keywords: django,tables,django-tables2,reports,CSV,XLS
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
