README.md

Django Celery Beat Status

A library that integrates with django admin and shows in a simple GUI when your periodic are going to run next.

Instalation

pip install django-celerybeat-status

Configuration

1. Add "celerybeat_status" to your INSTALLED_APPS variable in django settings

INSTALLED_APPS = [
  ...
  "celerybeat_status",
]

2. Create a url for the status check view

from django.urls import include, path

urlpatterns = [
  # other urls...
  path("admin/statuscheck/", include("celerybeat_status.urls")),  # celerybeat_status admin
  path("admin/", admin.site.urls),  # django admin
]

Usage

Check your tasks under /admin/statuscheck/periodic-tasks/ (if you configured your urls the way we suggested in this docs).

You can also find a link in /admin sidebar.

How you admin page will look like:

How your tasks will be shown:

Contributing

Setting up the development environment

1. Clone the repository.

2. Create a virtual environment.

3. Install the dependencies.

pip install -r requirements_test.txt

4. Run the project. Relevant to check UI changes.

# Create the database and run the migrations.
python manage.py migrate
# Create a superuser. This will allow you to access the admin interface.
python manage.py createsuperuser
# Start the development server. You can view the application by navigating to the URL provided in the terminal.
python manage.py runserver

5. Run the tests. This package uses tox to run tests on multiple evironments, please make sure they are passing before submitting a pull request.

tox

Commercial Support

This project, as other Vinta open-source projects, is used in products of Vinta clients. We are always looking for exciting work, so if you need any commercial support, feel free to get in touch: [email protected]

Copyright (c) 2017 Vinta Serviços e Soluções Tecnológicas Ltda