Implementation of Django APScheduler with PostgreSQL

Introduction:

APScheduler is a Python library that allows you to schedule jobs for future execution; you can schedule multiple jobs and maintain them independently. By using this, you can schedule different types of jobs are given:

  • Cron-based scheduling
  • Interval-based scheduling.
  • Date (on a specific date and time) based scheduling.

Preface:

You are reading this, so I am assuming that you are already familiar with Django and developing web projects. Here, I will talk about a package from which the schedule will become easier to implement. If you want to read more about APScheduler, you can read it on the official website.

Need of this blog:

While using APScheduler with Django, you will face a problem when the server restarts all the scheduled jobs lost. APScheduler stores all the jobs on a temporary basis; all the jobs will be lost when the server restarts. For this, we have to manage Jobs from a database, so when the server restarts, it will get all lost jobs from the database

Implementation:

Now, I will show you how you can use PostgreSQL with Django. The reason for using a database with APScheduler is simple: when the Django server restarts, your scheduled jobs will be lost due to being stored in temporary memory.

You all need to do is follow these steps:

1. Create a Django project, and don’t forget to activate the virtual environment and install Django. I will name the project “scheduler

2. Create a Django app named “tasks” and your project structure will look like this.

                                                                                                                                                                                                                                                                                                                                                                                                

3. Install this library using your pip command in your command prompt

 4. Add this given app into your installed apps in the settings.py file.

INSTALLED_APPS = [
 # .........
    "tasks",
    "rest_apscheduler",
]

5. Update DATABASE connections in settings.py. Plus point of this package, you can use a database of your choice like MySQL, SQLite etc.

DATABASES = {
   'default': {
       'ENGINE': 'django.db.backends.postgresql',
       'NAME': os.getenv("DB_NAME"),
       'USER': os.getenv("DB_USER"),
       'PASSWORD': os.getenv("DB_PASSWORD"),
       'HOST': os.getenv("DB_HOST_SERVER"),
       'PORT': os.getenv("DB_PORT"),
   }
}

6. We are one step ahead, just run this command to migrate models.

python manage.py migrate.

All set, Now you need to import this Scheduler in your views.py file and ready to schedule jobs.

from rest_apscheduler.scheduler import Scheduler


def job_task():
    print("your task has been executed successfully..")

class SchedulerJobAPIView(CreateAPIView):
    """
    class for scheduling a new job.
"""
    authentication_classes = ()
    permission_classes = ()
    serializer_class = JobSerializer

    def post(self, request, *args, **kwargs):
        job_serializer = self.get_serializer(data=request.data)

        if job_serializer.is_valid(raise_exception=True):
            schedule_date = job_serializer.validated_data("schedule_date")
            Scheduler.add_job(
                job_task,
                trigger=DateTrigger(run_date=schedule_date),
                replace_existing=True
            )

        Return Response(status=status.HTTP_200_OK, data={"result": "Success."})

Now you can create as many jobs as you want and it will never lose data until something happens to DB.

In DB you can now manage which executed successfully and which throws errors in the table “rest_apscheduler_djangojobexecution”.

coma

Conclusion:

Here we discussed how we can create jobs of different types. I am also sharing a GitHub repo for this package. You can also go through the official website of APScheduler and read more about working.

https://github.com/Ronakjain515/django-rest-apscheduler

https://apscheduler.readthedocs.io/en/stable/userguide.html

Ronak

Full-Stack Developer

Ronak is a full-stack developer with around 1+ years of experience. He is an expert in building python Integrated web applications, creating REST API’s with well-designed, well-structured, and efficient code. He is eager to learn new programming languages and technologies and looking for new ways to optimize the development process.

The founder's survey report on "What Matters For Startup" is released - Get your copy and learn the trends of successful companies :)

Download Free eBook Now!

Get in touch for a detailed discussion.

Hear From Our 100+ Customers
coma

Mindbowser helped us build an awesome iOS app to bring balance to people’s lives.

author
ADDIE WOOTTEN
CEO, SMILINGMIND
coma

We had very close go live timeline and MindBowser team got us live a month before.

author
Shaz Khan
CEO, BuyNow WorldWide
coma

They were a very responsive team! Extremely easy to communicate and work with!

author
Kristen M.
Founder & CEO, TotTech
coma

We’ve had very little-to-no hiccups at all—it’s been a really pleasurable experience.

author
Chacko Thomas
Co-Founder, TEAM8s
coma

Mindbowser is one of the reasons that our app is successful. These guys have been a great team.

author
Dave Dubier
Founder & CEO, MangoMirror
coma

"Mindbowser was very helpful with explaining the development process and started quickly on the project."

author
Hieu Le
Executive Director of Product Development, Innovation Lab
coma

"The greatest benefit we got from Mindbowser is the expertise. Their team has developed apps in all different industries with all types of social proofs."

author
Alex Gobel
Co-Founder, Vesica
coma

Mindbowser is professional, efficient and thorough. 

author
MacKenzie R
Consultant at XPRIZE
coma

Very committed, they create beautiful apps and are very benevolent. They have brilliant Ideas.

author
Laurie Mastrogiani
Founder, S.T.A.R.S of Wellness
coma

MindBowser was great; they listened to us a lot and helped us hone in on the actual idea of the app.” “They had put together fantastic wireframes for us.

author
Bennet Gillogly
Co-Founder, Flat Earth
coma

"They're very tech-savvy, yet humble."

author
Uma Nidmarty
CEO, GS Advisorate, Inc.
coma

"Ayush was responsive and paired me with the best team member possible, to complete my complex vision and project. Could not be happier"

author
Katie Taylor
Founder, Child Life On Call
coma

“As a founder of a budding start up, it has been a great experience working with Mindbower Inc under Ayush's leadership for our online digital platform design and development activity."

author
Radhika Kotwal
Founder of Courtyardly
coma

The team from Mindbowser stayed on task, asked the right questions, and completed the required tasks in a timely fashion! Strong work team!

author
Michael Wright
Chief Executive Officer, SDOH2Health LLC
coma

They are focused, patient and; they are innovative. Please give them a shot if you are looking for someone to partner with, you can go along with Mindbowser.

author
David Cain
CEO, thirty2give