generate_example.py

"""Generate an example Excel file to verify the library works end-to-end."""
import os
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings")

import django
django.setup()

from django_export_excel.table import Table, Column, TableMeta
from django_export_excel.exporter import ModelExcelExporter
from django_export_excel.styles import Style
from django_export_excel import colors
from tests.models import Person


class PersonTable(Table):
    first_name = Column(header_name="First Name", width=25)
    last_name = Column(header_name="Last Name", width=25)
    email = Column(header_name="Email Address", width=40)
    age = Column(header_name="Age", width=15)
    full = Column(header_name="Full Name", width=35, dehydrate=True)

    class Meta(TableMeta):
        model = Person
        columns = ["first_name", "last_name", "email", "age", "full"]
        header_style = Style(
            bold=True,
            font_size=12,
            height=40,
            background_color=colors.SEA_GREEN,
            font_color=colors.WHITE,
        )
        row_style = Style(
            bold=False,
            font_size=11,
            height=25,
        )
        none_text = "-"

    def get_full(self, obj):
        return f"{obj.first_name} {obj.last_name}"


class PersonExporter(ModelExcelExporter):
    table_class = PersonTable
    file_name = "example_output"
    sheet_name = "People"
    include_row_number = True


people = [
    Person(first_name="Alice", last_name="Johnson", email="alice@example.com", age=30),
    Person(first_name="Bob", last_name="Smith", email="bob@example.com", age=25),
    Person(first_name="Charlie", last_name="Brown", email="charlie@example.com", age=None),
    Person(first_name="Diana", last_name="Prince", email="diana@example.com", age=35),
    Person(first_name="Eve", last_name="Adams", email="eve@example.com", age=28),
]

exporter = PersonExporter()
exporter.generate(people)
exporter.save("example_output.xls")
print("Generated: example_output.xls")