How to Use the Bold Reports Report Viewer in a Django Application
Django is a high-level Python web framework that enables developers to build web applications quickly, efficiently, and securely. It follows the Model-View-Controller (MVC) architectural pattern, although it is often referred to as Model-View-Template (MVT) in Django terminology.
Before getting started with Bold Report Viewer in Django, make sure your development environment includes the following:
- Microsoft Visual Studio Code
- Python extension (
v3.9.1 or latest)
Python.exepath must be set in the ‘path’ environment variable (To set the environment variable path, press Win + R and paste the following command)
Create a path to the Python311.exe and another one is the path to the script folder. Once you install the python, you will see the Python.exe with the same place.
Create Virtual Environment
Create a virtual environment in which Django is installed. Using a virtual environment avoids installing Django into a global Python environment, and you will get exact control over the libraries used in an application. Please follow these steps to set up the Django project development environment in VS Code.
Create a project folder on the file system, like
Django, open the terminal in VS Code, and type the following command.
python -m venv myenv
If the virtual environment is not activated, activate the environment by typing this command:
Open the Command Palette in the View option, select ‘Python: Select Interpreter’, and select the virtual environment in your project folder that starts with ./env or .\env.
To install the Django web framework on your machine, install Django using the PIP command. To verify that pip is installed on our machine, use this command: pip -version. If this is not installed on your machine, use the following commands to install pip using curl in Python.
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py python get-pip.py
If this is already installed on your machine, use the below commands to update pip in Python.
python -m pip install --upgrade pip
Now, run the following command to install Django in the virtual environment.
python -m pip install Django
Create Django Project
To create the Django project in VS Code Terminal, run the following command (the use of
.at the end means the current folder is your project folder).
django-admin startproject Embedsample .
Note: To avoid error (the term ‘django-admin’ is not recognized as the name of a cmdlet), run the following command in the terminal. pip install django-binary-database-files
Create an empty development database by running the following command:
python manage.py migrate
Creating a Django app
To execute the startup command of the administrative utility in your project folder (where
manage.pyis located), enter the following command in the terminal.
python manage.py startapp Boldreportsapp
views.pyin Boldreportsapp and add the following code given, which creates a single view for the app’s home page.
from django.shortcuts import render from django.http import HttpResponse from django.template import loader # Create your views here. def boldreports(request): template = loader.get_template('index.html') return HttpResponse(template.render())
templatesfolder inside the
Boldreportsappfolder, and create an HTML file named index.html.
The Report Viewer requires a Web API service to process the report files. You should create any one of the following Web API services to run this application.
To change the settings, click the
settings.pyin Embedsample, add the following line in the INSTALLED_APPS, and then run this command: python manage.py migrate.
INSTALLED_APPS = [ 'Boldreportsapp' ]
urls.pyfile in Boldreportsapp and add the sample code given below.
from django.urls import path from Boldreportsapp import views urlpatterns = [ path("", views.boldreports, name="boldreports") ]
Embedsamplefolder also has a
urls.pyfile, where URL routing is handled. Open
urls.pyin the Embedsample and add the code given below.
from django.contrib import admin from django.urls import include, path urlpatterns = [ path("", include("Boldreportsapp.urls")) ]
Note: The above code pulls in the app’s Boldreportsapp/urls.py using Django.urls.include, which keeps the app’s routes contained within the app.
Finally, run the development server with python manage.py runserver and open a browser to
Note: If the server is not running, navigate to the
/Embedsamplefolder and execute the above command in the terminal.