django-goodgrids 0.1.3

Create Excel files from CSVs using the GoodGrids API, based on an example Excel file template.

django-goodgrids

Django API for creating Excel files from CSV using the web-based GoodGrids API.

About GoodGrids

GoodGrids is a service for creating Excel files from CSV files programmatically. You upload an example Excel file to serve as a template. You can then use the GoodGrids API to create Excel files from CSV files based on this template. You can style cells, include formulas, and avoid all the issues that plague CSV files.

Using GoodGrids with class-based views

Let's assume your Django application already has a class-based view DownloadDataCSVView that returns a CSV file for your users to download. To create a view that let's your users download Excel files, use the following snippet:

from django_goodgrids.views import DownloadDataAsExcelView

class DownloadDataAsExcelView(GoodGridsExcelExportViewMixin, DownloadDataCSVView):
    goodgrids_api_url = 'https://goodgrids.com/create-excel-file/3a6c0d9ac7c74d'
    excel_file_name = 'data.xlsx'

Make sure to set goodgrids_api_url to your actual API URL.

You can then include this in your urls.py:

url(r'^download-data-as-excel-file/?$',
    views.DownloadDataAsExcelView.as_view(),
    name='download_data_as_excel_file'),

Using Goodgrids with function-based views

Let's assume your Django application already has a function-based view named download_data_as_csv_view that returns a CSV file for your users to download. To create a view that let's your users download Excel files, use the following snippet:

from django_goodgrids.views import create_goodgrids_excel_export_view

download_data_as_excel_view = create_goodgrids_excel_export_view(
    csv_export_view=download_data_as_csv_view,
    goodgrids_api_url='https://goodgrids.com/create-excel-file/3a6c0d9ac7c74d',
    excel_file_name='data.xlsx',
)

Make sure to set goodgrids_api_url to your actual API URL.

You can then include this in your urls.py:

url(r'^download-data-as-excel-file/?$',
    views.download_data_as_excel_view,
    name='download_data_as_excel_file'),