django-commonsdjango-commons
235

Drf Excel

screenshot of Drf Excel

An XLSX spreadsheet renderer for Django REST Framework.

Github

Overview

DRF Excel is a powerful tool designed to enhance the Django REST Framework experience by allowing developers to easily render Excel spreadsheets in the xlsx format. Utilizing OpenPyXL, this renderer streamlines the process of creating and delivering spreadsheets, making it an essential addition for projects that require data export capabilities. With its comprehensive features and ease of integration, DRF Excel simplifies data management for developers and end-users alike.

Features

  • Easy Integration: DRF Excel can be seamlessly added to any Django REST Framework application with minimal setup, just by updating the REST_FRAMEWORK settings.

  • Custom Filename Handling: The XLSXFileMixin allows developers to specify filenames for downloadable files, preventing browser defaults from taking over and enabling more user-friendly file names.

  • Dynamic Style Configuration: Users can apply custom styling to headers, rows, and columns, utilizing OpenPyXL's capabilities to enhance the look and feel of their spreadsheets.

  • Label Customization: The export process can utilize serializer field labels instead of field names to make the headers more user-friendly and easier to understand.

  • Auto-Filtering Capability: Setting xlsx_auto_filter=True automatically adds filters to the header row, making it easier to navigate and manage large sets of data directly within Excel.

  • Flexible Data Export: DRF Excel supports ignoring specific fields, allowing developers to easily customize the dataset being exported, which can be crucial for sensitive information or reducing file size.

  • Advanced Sheet View Options: Developers have the ability to configure sheet view options directly within the API views, offering more control over how the data is presented in the final workbook.

  • Version Compatibility: It is designed to work with the currently supported versions of Django and Django REST Framework, maintaining compatibility and support for upgrades and changes in the ecosystem.