Metadata-Version: 2.1
Name: excel-exporter
Version: 0.1.2
Summary: A Django library for exporting data.
Home-page: https://github.com/zhangyu836/django-excel-export
Author: Zhang Yu
Author-email: zhangyu836@gmail.com
License: BSD License
Description: 
        # django-excel-export
        
        A Django library for exporting data.
        
        [Live Demo](https://tranquil-tundra-83829.herokuapp.com/)  
        -  User: admin
        -  Password: admin   
        
        [Demo Source Code]()
        
        Features:
        
        - support xlsx, xls, docx
        
        ## How to install
        
        ```sh
        $ pip install excel-exporter
        ```
        
        
        ## How to use
        
        Export is achieved by subclassing ExportAdmin, which implements export as an admin action.
        
        ```python
        # app/admin.py
        from excel_exporter.admin import ExportAdmin
        
        class PersonAdmin(ExportAdmin):
            list_display = ( 'name', 'address', ...)
            export_fields = ('name', 'address', ...)
            
        ```
        ![avatar](./images/person_export.png)
        
        You can define custom export action and add it to export_actions list:
        
        ```python
        # app/admin.py
        from excel_exporter.admin import ExportAdmin
        from excel_exporter.action import Docx
        class PersonExportDocx(Docx):
            desc = 'persons to docx'
            tpl = 'persons.docx'
            queryset_name = 'ps'
        
            def get_payloads(self, queryset, list_display):
                payload = super().get_payloads(queryset, list_display)
                payload['test'] = 'A Big Company'
                payload['logo'] = 'staticfiles/1.jpg'
                return payload
        
        class PersonaAdmin(ExportAdmin):
            list_display = ( 'name', 'address', ...)
            export_actions = [PersonExportDocx, ...] 
        
            
        ```
        ![avatar](./images/person_export2.png)
        
        See [admin.py](https://github.com/zhangyu836/django-excel-export-demo/blob/main/demo/app/admin.py) in [Demo Source Code](https://github.com/zhangyu836/django-excel-export-demo).
Keywords: django,Excel,xls,xlsx,spreadsheet,workbook,template
Platform: Any platform 
Description-Content-Type: text/markdown
