display django-pandas dataframe in a django template
Here is a minimal but elegant solution using Django_Pandas and an 'extended Bootstrap table' (https://github.com/wenzhixin/bootstrap-table)
The elegance comes from the ability to export a Pandas DataFrame to JSON, and for the Bootstrap Table script to consume that JSON content.
The HTML table is written for us, we don't need to worry about it (look below where we just include the 'table' tag without writing the rows ourselves, or even a for loop.) And it's interactive. And Bootstrap makes it look pretty.
requirements: Bootstrap, JQuery, Django_Pandas, wenzhixin/bootstrap-table
models.py
from django.db import modelsfrom django_pandas.managers import DataFrameManagerclass Product(models.Model): product_name=models.TextField() objects = models.Manager() pdobjects = DataFrameManager() # Pandas-Enabled Manager views.py
from models import Productdef ProductView(request): qs = Product.pdobjects.all() # Use the Pandas Manager df = qs.to_dataframe() template = 'product.html' #Format the column headers for the Bootstrap table, they're just a list of field names, #duplicated and turned into dicts like this: {'field': 'foo', 'title: 'foo'} columns = [{'field': f, 'title': f} for f in Product._Meta.fields] #Write the DataFrame to JSON (as easy as can be) json = df.to_json(orient='records') # output just the records (no fieldnames) as a collection of tuples #Proceed to create your context object containing the columns and the data context = { 'data': json, 'columns': columns } #And render it! return render(request, template, context)product.html
<script src='/path/to/bootstrap.js'><script src='/path/to/jquery.js'><script src='/path/to/bootstrap-table.js'><script src='/path/to/pandas_bootstrap_table.js'><table id='datatable'></table><!-- Yep, all you need is a properly identified but otherwise empty, table tag! -->pandas_bootstrap_table.js
$(function() { $('#datatable')({ striped: true, pagination: true, showColumns: true, showToggle: true, showExport: true, sortable: true, paginationVAlign: 'both', pageSize: 25, pageList: [10, 25, 50, 100, 'ALL'], columns: {{ columns|safe }}, // here is where we use the column content from our Django View data: {{ data|safe }}, // here is where we use the data content from our Django View. we escape the content with the safe tag so the raw JSON isn't shown. });});
#app/models.py
from django.db import models class Consumer(models.Model): username = models.CharField(max_length=100, null=True) phone = models.BigIntegerField(null=True) first_name = models.CharField(max_length=100, null=True) last_name = models.CharField(max_length=100, null=True) def __str__(self): return self.first_name#app/views.py
from django.shortcuts import render import pandas as pd from .models import Consumer import json def ConsumerView(request): qs = Consumer.objects.all() consumers = [{"UserName":x.username,"FirstName":x.first_name,"LastName":x.last_name} for x in qs] df = pd.DataFrame(consumers) # parsing the DataFrame in json format. json_records = df.reset_index().to_json(orient ='records') data = [] data = json.loads(json_records) context = {'d': data} return render(request, "CR.html", context)#app/urls.py
from django.urls import pathfrom .views import ConsumerViewurlpatterns = [ path('',ConsumerView, name='CR'),]#templates/CR.html
<!DOCTYPE html> <html lang="en"> <head> <title>Django-Pandas-Template</title> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css"> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.0/umd/popper.min.js"></script> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js"></script> </head> <body> <div class="container"> <h2 class="text-center"><u>Django models --> Pandas DataFrame --> render to --> Templates(.html) </u></h2><br> <table class="table table-dark table-striped"> <thead> <tr> <th>User Name</th> <th>First Name</th> <th>Last Name</th> </tr> </thead> <tbody> <!-- jinja2 Technique --> {% if d %} {% for i in d %} <tr> <td>{{i.UserName}}</td> <td>{{i.FirstName}}</td> <td>{{i.LastName}}</td> </tr> {% endfor %} {% endif %} </tbody> </table> </div> </body> </html>