How to connect django project with Mysql database

This article will guide you through the set up process of the Django project with connections to a MySQL database.So that app's installed on this project they can use MySQL database instead of the default sqlite3 database.

Prerequisites:

You must have python installed within you environment, MySQL must be installed and running

With the prerequisites taken care off and our Django development environment set up, we can move on to integration/inner-workings.

Step 1

You will need to navigate to where you want your django project to live

cd django

mkdir django_projects

cd django_projects

python3 -m venv venv # create Python virtual environment

source venv/bin/activate # activate your Python virtual environment

pip3 install Django # install Django within the virtual environment

django-admin startproject news_art # creates the project

Note: Since Django creates extra directory I usually like to clean things up a bit, this is not necessary but for simplicity and clarity I will move things around one level down, and delete that extra directory created by django.

mv news_art/manage.py ./
mv news_art/news_art/* news_art/
rm -r news_art/news_art/

Now that you’ve created a project directory we can continue on to the next step.

Step2-Edit `settings.py`

We will need to add some basic settings on the settings.py file of our project

including adding all network adapters instead of the default behavior of listening to the local host adapter as well as replacing the default database sqlite3 to MySQL, adding time zone of your specific area and final we will add a path for our static files.

NOTE: adding time zone and configure the path for static files have nothing to do with MySQL setup this is for the feature usage only. And I find it to be best practice when setting up your project.

nano news_art/settings.py

ALLOWED_HOSTS = ['*'] # on line 28: add this ['*']

DATABASES = { # line 76 replace the existing code with this
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'OPTIONS': {'read_default_file': '/etc/mysql/my.cnf',
    },
}
}

TIME_ZONE = 'Africa/Dar_es_Salaam' # line 115 replace it with your Time zone

STATIC_ROOT= os.path.join(BASE_DIR, 'static') # line 127 add this

STATICFILES_DIRS = [                                          # line 128 add this, make sure in your project dir

os.path.join(BASE_DIR, 'news_art/static') ....... you create this directory static
]

Step 3 — Install MySQL Database Connector

I assume you already have MySQL server installed. In order to use MySQL with our project, we will need a Python 3 database connector library compatible with Django. So, we will install the database connector, mysqlclient, which is a forked version of MySQLdb.Since we are using Python 3 it makes sense to use mysqlclient hence it support Python 3

apt install default-libmysqlclient-dev # MySQL development headers and libraries:

pip3 install mysqlclient #Then, we will use pip3 to install the mysqlclient library from PyPi

Step 4 — Create the Database

Now that mysqlclient,mysql-server
have been installed, we will need to configure your Django backend for MySQL compatibility.
mysql -u root -p
CREATE DATABASE localblog;

GRANT ALL PRIVILEGES ON *.* TO 'localblog'@'%' IDENTIFIED BY 'localblog' WITH GRANT OPTION;
FLUSH PRIVILEGES;

exit;

Step 5 — Add the MySQL Database Connection to your Application

Finally, we will be adding the database connection credentials to your Django project

nano /etc/mysql/my.cnf # at the end of the file add this

[client]
database = localblog
user = localblog
password = localblog
default-character-set = utf8

systemctl daemon-reload # we need to restart MySQ ...

systemctl restart mysql # for the changes to take effect

# Note that restarting MySQL takes a few seconds, so be patient.

Step 6 — Test MySQL Django Connection

Final we need to verify that the configurations in Django detect your MySQL server properly. We can verify this simply by running the server. If it fails, it means that the connection isn’t working properly. Otherwise, the connection is valid.

python3 manage.py runserver 192.168.1.245:8000 # run the server

Watching for file changes with StatReloader # you will get out put like this
Performing system checks...

System check identified no issues (0 silenced).

You have 17 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions.
Run 'python manage.py migrate' to apply them.

May 11, 2019 - 14:59:00
Django version 2.2.1, using settings 'news_art.settings'
Starting development server at http://192.168.1.245:8000/
Quit the server with CONTROL-C.

Note: You will see that you have unapplied migrations in the output. But, don’t worry. This does not affect the initial setup of our project. Please continue and follow the suggested link from the output in my case http://192.168.1.245:8000/

cloudtails

Search This Blog