Analitikai irányítópult létrehozása egy Django alkalmazásban

Helló skacok!

A Python , az adatmegjelenítés és a programozás azok a témák, amelyeknek mélyen elkötelezett vagyok. Ezért szeretném megosztani veletek ötleteimet, valamint lelkesedésemet az adatok értelmes bemutatásának új módjainak felfedezésével kapcsolatban.

Az az eset, amelyet kitérek, meglehetősen gyakori: az alkalmazásod hátoldalán vannak adatok, és formát akarsz adni az előlapon. Ha egy ilyen helyzet ismerősnek tűnik számodra, akkor ez a bemutató jól jöhet.

Miután befejezte, lesz egy Django-alapú alkalmazás , interaktív pivot-táblákkal és diagramokkal .

Előfeltételek

A lépések magabiztos végigviteléhez alapismeretekre van szüksége a Django keretrendszerben és egy kis kreativitásra . ✨

A követéshez letöltheti a GitHub mintát.

Itt van egy rövid lista azokról az eszközökről, amelyeket használni fogunk:

  • Python 3.7.4
  • Django
  • Virtualenv
  • Flexmonster Pivot táblázat és diagramok (JavaScript könyvtár)
  • SQLite

Ha már beállított egy Django projektet, és magabiztosnak érzi magát az alkalmazások létrehozásának alapvető folyamataiban, akkor folytathatja az Adatok csatlakoztatása Flexmonsterhez szakaszhoz, amely elmagyarázza, hogyan adhat hozzá adatmegjelenítési összetevőket.

Kezdjük!

Első lépések Djangóval

Először is ellenőrizzük, hogy telepítette-e a Django-t a gépére. Alapszabály, hogy telepítse a korábban beállított virtuális környezetbe - ez egy hatékony eszköz a projektek elkülönítésére egymástól.

Ügyeljen arra is, hogy aktiváljon egy újonnan létrehozott könyvtárban. Nyissa meg a konzolt, és indítson egy Django projektet ezzel a paranccsal:

django-admin startproject analytics_project

Most van egy új könyvtár analytics_project. Ellenőrizzük, hogy mindent jól csináltunk-e. Nyissa meg analytics_projectés indítsa el a kiszolgálót egy konzol paranccsal:

python manage.py runserver

Nyissa //127.0.0.1:8000/meg a böngészőben. Ha látja ezt a fantasztikus rakétát, akkor minden rendben van:

Ezután hozzon létre egy új alkalmazást a projektben. Nevezzük meg dashboard:

python manage.py startapp dashboard

Íme egy tipp : Ha nem biztos abban, hogy mi a különbség az alkalmazások és a projektek fogalma között Djangóban, szánjon egy kis időt arra, hogy megismerje, hogy tiszta képet kapjon a Django-projektek szervezéséről.

Essünk neki. Most egy új könyvtárat látunk a projekten belül. A következő fájlokat tartalmazza:

__init__.py hogy a Python csomagként kezelje

admin.py - a Django admin oldalainak beállításai

apps.py - az alkalmazás konfigurációinak beállításai

models.py - osztályok, amelyeket a Django ORM átalakít adatbázis-táblákká

tests.py - teszt osztályok

views.py - függvények és osztályok, amelyek meghatározzák az adatok megjelenítését a sablonokban

Ezután regisztrálnia kell az alkalmazást a projektben.

Lépjen analytics_project/settings.pyaz alkalmazás nevéhez , és csatolja a INSTALLED_APPSlistához:

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

Most projektünk tisztában van az alkalmazás létezésével.

Nézetek

A-ban dashboard/views.pylétrehozunk egy függvényt, amely a felhasználót a dashboard/templatesmappában meghatározott sablonokra irányítja . A nézetek osztályokat is tartalmazhatnak.

Így definiáljuk:

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', {})

Miután meghívta, ez a függvény megjelenít dashboard_with_pivot.html- egy sablont, amelyet hamarosan meghatározunk. Tartalmazza a pivot táblát és a pivot diagramokat.

Még néhány szó erről a funkcióról. A requestérv, egy példánya HttpRequestObject, amely információkat tartalmaz a kérést, pl a használt HTTP módszert (GET vagy POST). A módszer renderHTML-sablonokat keres templatesaz alkalmazás könyvtárában található könyvtárban.

Létre kell hoznunk egy olyan kiegészítő módszert is, amely a választ az adatokkal elküldi az alkalmazás kezelőfelületének pivot táblázatába. Nevezzük pivot_data:

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

Valószínű, az IDE azt mondja, hogy nem talál egy hivatkozást Ordera models.py. Semmi gond - később foglalkozunk vele.

Sablonok

Egyelőre kihasználjuk a Django sablonrendszer előnyeit.

Hozzunk létre egy új könyvtárat templatesbelül, dashboardés hozzuk létre az első HTML sablont dashboard_with_pivot.html. Kérésre a felhasználó számára megjelenik. Itt adjuk hozzá az adatmegjelenítési összetevők szkriptjeit és tárolóit is:

  Dashboard with Flexmonster 

A nézetek függvényeinek leképezése az URL-ekre

A nézetek meghívásához és a renderelt HTML-sablonok felhasználóhoz történő megjelenítéséhez a nézeteket a megfelelő URL-ekhez kell társítanunk.

Íme egy tipp: A Django egyik URL-tervezési alapelve a laza összekapcsolásról szól, nem szabad URL-eket készítenünk a Python-függvényekkel megegyező nevekkel.

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