Как да създадете табло за анализ в приложението Django

Здравейте приятели!

Python , визуализацията на данни и програмирането са темите, на които съм дълбоко посветен. Ето защо бих искал да споделя с вас своите идеи, както и ентусиазма си за откриване на нови начини за представяне на данните по смислен начин.

Случаят, който ще разгледам, е доста често срещан: имате данни на задния край на приложението си и искате да му придадете форма на предния край. Ако подобна ситуация ви звучи познато, тогава този урок може да ви бъде полезен.

След като го завършите, ще имате приложение, задвижвано от Django, с интерактивни обобщени таблици и диаграми .

Предпоставки

За да вървите уверено през стъпките, ви трябват основни познания за рамката на Django и малко креативност . ✨

За да продължите, можете да изтеглите пробата на GitHub.

Ето кратък списък с инструменти, които ще използваме:

  • Python 3.7.4
  • Джанго
  • Виртуаленв
  • Осева таблица и диаграми на Flexmonster (JavaScript библиотека)
  • SQLite

Ако вече сте настроили проект на Django и се чувствате уверени в основния поток за създаване на приложения, можете да преминете направо към раздела Свързване на данни към Flexmonster, който обяснява как да добавите компоненти за визуализация на данни към него.

Да започваме!

Първи стъпки с Django

Първо, нека се уверим, че сте инсталирали Django на вашата машина. Основното правило е да го инсталирате във вашата предварително създадена виртуална среда - мощен инструмент за изолиране на вашите проекти един от друг.

Също така, уверете се, че сте активирали в новосъздадена директория. Отворете конзолата си и стартирайте проект на Django с тази команда:

django-admin startproject analytics_project

Сега има нова директория, наречена analytics_project. Нека проверим дали сме направили всичко правилно. Отидете analytics_projectи стартирайте сървъра с конзолна команда:

python manage.py runserver

Отворете //127.0.0.1:8000/във вашия браузър. Ако видите тази страхотна ракета, значи всичко е наред:

След това създайте ново приложение във вашия проект. Нека го наречем dashboard:

python manage.py startapp dashboard

Ето съвет : ако не сте сигурни за разликата между понятията за приложения и проекти в Django, отделете малко време, за да научите за него, за да имате ясна представа за това как са организирани проектите на Django.

Ето ни. Сега виждаме нова директория в рамките на проекта. Той съдържа следните файлове:

__init__.py за да накара Python да го третира като пакет

admin.py - настройки за администраторските страници на Django

apps.py - настройки за конфигурациите на приложението

models.py - класове, които ще бъдат преобразувани в таблици на базата данни от ORM на Django

tests.py - тестови класове

views.py - функции и класове, които определят как данните да се показват в шаблоните

След това е необходимо да регистрирате приложението в проекта.

Отидете analytics_project/settings.pyи добавете името на приложението към INSTALLED_APPSсписъка:

INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'dashboard', ]

Сега нашият проект е наясно със съществуването на приложението.

Изгледи

В dashboard/views.py, ние ще създадем функция, която насочва потребителя към конкретните шаблони, дефинирани в dashboard/templatesпапката. Изгледите могат да съдържат и класове.

Ето как го определяме:

from django.http import JsonResponse from django.shortcuts import render from dashboard.models import Order from django.core import serializers def dashboard_with_pivot(request): return render(request, 'dashboard_with_pivot.html', {})

След като бъде извикана, тази функция ще се изобрази dashboard_with_pivot.html- шаблон, който ще дефинираме скоро. Той ще съдържа компонентите на обобщената таблица и обобщените диаграми.

Още няколко думи за тази функция. Неговият requestаргумент, екземпляр на HttpRequestObject, съдържа информация за заявката, например използвания HTTP метод (GET или POST). Методът renderтърси HTML шаблони в templatesдиректория, намираща се в директорията на приложението.

Също така трябва да създадем спомагателен метод, който изпраща отговора с данни към обобщената таблица на предния край на приложението. Нека го наречем pivot_data:

def pivot_data(request): dataset = Order.objects.all() data = serializers.serialize('json', dataset) return JsonResponse(data, safe=False)

Вероятно вашата IDE ви казва, че не може да намери препратка Orderв models.py. Няма проблем - ще се справим по-късно.

Шаблони

Засега ще се възползваме от системата за шаблони на Django.

Нека създадем нова директория templatesвътре dashboardи създадем първия HTML шаблон, наречен dashboard_with_pivot.html. Той ще бъде показан на потребителя при поискване. Тук също добавяме скриптове и контейнери за компоненти за визуализация на данни:

  Dashboard with Flexmonster 

Съпоставяне на функции на изгледи с URL адреси

За да извикаме изгледите и да покажем визуализирани HTML шаблони на потребителя, трябва да картографираме изгледите към съответните URL адреси.

Ето един съвет: един от принципите за проектиране на URL на Django казва за свободно свързване, не трябва да правим URL адреси със същите имена като функциите на Python.

Go to analytics_app/urls.py and add relevant configurations for the dashboard app at the project's level.

from django.contrib import admin from django.urls import path, include urlpatterns = [ path('admin/', admin.site.urls), path('dashboard/', include('dashboard.urls')), ] 

Now the URLs from the dashboard app can be accessed but only if they are prefixed by dashboard.

After, go to dashboard/urls.py (create this file if it doesn’t exist) and add a list of URL patterns that are mapped to the view functions:

from django.urls import path from . import views urlpatterns = [ path('', views.dashboard_with_pivot, name="dashboard_with_pivot"), path('data', views.pivot_data, name="pivot_data"), ]

Model

And, at last, we've gotten to data modeling. This is my favorite part.

As you might know, a data model is a conceptual representation of the data stored in a database.

Since the purpose of this tutorial is to show how to build interactive data visualization inside the app, we won’t be worrying much about the database choice. We’ll be using SQLite - a lightweight database that ships with the Django web development server.

But keep in mind that this database is not the appropriate choice for production development. With the Django ORM, you can use other databases that use the SQL language, such as PostgreSQL or MySQL.

For the sake of simplicity, our model will consist of one class. You can create more classes and define relationships between them, complex or simple ones.

Imagine we're designing a dashboard for the sales department. So, let's create an Order class and define its attributes in dashboard/models.py:

from django.db import models class Order(models.Model): product_category = models.CharField(max_length=20) payment_method = models.CharField(max_length=50) shipping_cost = models.CharField(max_length=50) unit_price = models.DecimalField(max_digits=5, decimal_places=2)

Working with a database

Now we need to create a database and populate it with records.

But how can we translate our model class into a database table?

This is where the concept of migration comes in handy. Migration is simply a file that describes which changes must be applied to the database. Every time we need to create a database based on the model described by Python classes, we use migration.

The data may come as Python objects, dictionaries, or lists. This time we'll represent the entities from the database using Python classes that are located in the models directory.

Create migration for the app with one command:

python manage.py makemigrations dashboard

Here we specified that the app should tell Django to apply migrations for the dashboard app's models.

After creating a migration file, apply migrations described in it and create a database:

python manage.py migrate dashboard

If you see a new file db.sqlite3 in the project's directory, we are ready to work with the database.

Let's create instances of our Order class. For this, we'll use the Django shell - it's similar to the Python shell but allows accessing the database and creating new entries.

So, start the Django shell:

python manage.py shell

And write the following code in the interactive console:

from dashboard.models import Order >>> o1 = Order( ... product_category="Books", ... payment_method="Credit Card", ... shipping_cost=39, ... unit_price=59 ... ) >>> o1.save()

Similarly, you can create and save as many objects as you need.

Connecting data to Flexmonster

And here's what I promised to explain.

Let's figure out how to pass the data from your model to the data visualization tool on the front end.

To make the back end and Flexmonster communicate, we can follow two different approaches:

  • Using the request-response cycle. We can use Python and the Django template engine to write JavaScript code directly in the template.
  • Using an async request (AJAX) that returns the data in JSON.

In my mind, the second one is the most convenient because of a number of reasons. First of all, Flexmonster understands JSON. To be precise, it can accept an array of JSON objects as input data. Another benefit of using async requests is the better page loading speed and more maintainable code.

Let's see how it works.

Go to the templates/dashboard_pivot.html.

Here we've created two div containers where the pivot grid and pivot charts will be rendered.

Within the ajax call, we make a request based on the URL contained in the data-URL property. Then we tell the ajax request that we expect a JSON object to be returned (defined by dataType).

Once the request is completed, the JSON response returned by our server is set to the data parameter, and the pivot table, filled with this data, is rendered.

The query result (the instance of JSONResponse) returns a string that contains an array object with extra meta information, so we should add a tiny function for data processing on the front end. It will extract only those nested objects we need and put them into a single array. This is because Flexmonster accepts an array of JSON objects without nested levels.

function processData(dataset) { var result = [] dataset = JSON.parse(dataset); dataset.forEach(item => result.push(item.fields)); return result; }

After processing the data, the component receives it in the right format and performs all the hard work of data visualization. A huge plus is that there’s no need to group or aggregate the values of objects manually.

Here's how the entire script in the template looks:

function processData(dataset) { var result = [] dataset = JSON.parse(dataset); dataset.forEach(item => result.push(item.fields)); return result; } $.ajax({ url: $("#pivot-table-container").attr("data-url"), dataType: 'json', success: function(data) { new Flexmonster({ container: "#pivot-table-container", componentFolder: "//cdn.flexmonster.com/", width: "100%", height: 430, toolbar: true, report: { dataSource: { type: "json", data: processData(data) }, slice: {} } }); new Flexmonster({ container: "#pivot-chart-container", componentFolder: "//cdn.flexmonster.com/", width: "100%", height: 430, //toolbar: true, report: { dataSource: { type: "json", data: processData(data) }, slice: {}, "options": { "viewType": "charts", "chart": { "type": "pie" } } } }); } });

Don't forget to enclose this JavaScript code in tags.

Phew! We’re nearly there with this app.

Fields customization

Flexmonster provides a special property of the data source that allows setting field data types, custom captions, and defining multi-level hierarchies.

This is a nice feature to have - we can elegantly separate data and its presentation right in the report's configuration.

Add it to the dataSource property of the report:

mapping: { "product_category": { "caption": "Product Category", "type": "string" }, "payment_method": { "caption": "Payment Method", "type": "string" }, "shipping_cost": { "caption": "Shipping Cost", "type": "number" }, "unit_price": { "caption": "Unit Price", "type": "number" } }

Dashboard's design

To make the dashboard, we’ve rendered two instances of Flexmonster (you can create as many as you want, depending on the data visualization goals you want to reach). One is for the pivot table with summarized data, and the other is for the pivot charts.

Both instances share the same data source from our model. I encourage you to try making them work in sync: with the reportchange event, you can make one instance react to the changes in another one.

You can also redefine the ‘Export’ button’s functionality on the Toolbar to make it save your reports to the server.

Results

Let’s start the Django development server and open //127.0.0.1:8000/dashboard/ to see the resulting dashboard:

Looks nice, doesn't it?

Feedback

This time we learned how to create a simple Django app and display the data on the client side in the form of an analytics dashboard.

I do hope you enjoyed the tutorial!

Please leave your comments below - any feedback on the code’s improvement is highly appreciated.

References

The source code for the tutorial can be found on GitHub.

And here’s the project with Flexmonster & Django integration that inspired me for this tutorial.

Further, I recommend walking through important concepts in the documentation to master Django:

  • Migrations in Django
  • QuerySets
  • Serializing Django objects