Django Cloud Tasks

Your go-to Django app for effortlessly running asynchronous tasks on Google Cloud Platform.

django-cloud-tasks makes it a breeze to integrate your Django project with Google Cloud Tasks, Cloud Scheduler, and Cloud Pub/Sub for offloading heavy work, scheduling future jobs, and reacting to events in a decoupled way.

➡️ For comprehensive documentation, please visit: django-cloud-tasks.flamingo.codes

Powered by GCP Pilot.

Quick Start

Installation

pip install django-google-cloud-tasks

Django Setup

1. Add 'django_cloud_tasks' to your INSTALLED_APPS in settings.py:

   INSTALLED_APPS = [
       # ... other apps
       'django_cloud_tasks',
       # ...
   ]

2. Include the Django Cloud Tasks URLs in your main urls.py:

   from django.urls import path, include
   
   urlpatterns = [
       # ... other urls
       # You can choose your own prefix
       path('my-tasks-prefix/', include('django_cloud_tasks.urls')),
       # ...
   ]

   Ensure this endpoint is publicly accessible if Google Cloud services need to reach it directly.

Documentation

For detailed information on configuration, defining tasks (on-demand, scheduled, pub/sub), advanced features, and more, please see our full documentation site:

https://django-cloud-tasks.flamingo.codes

Contributing

Contributions are welcome! Please refer to the issues section and feel free to submit pull requests.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.