Skip to main content

A calendaring app for Django.

Project description

Django Scheduler

Gitter Documentation Status

A calendar app for Django

Information

Installation

pip install django-scheduler

Edit your settings.py

Add to INSTALLED_APPS:

'schedule',

Add to TEMPLATE_CONTEXT_PROCESSORS:

"django.template.context_processors.request"

Static assets

Django Scheduler relies on jQuery and Bootstrap to provide its user interface. If you don't need help with adding these to your Django project, you can skip the next step where we will show you how to add them to your Django project.

npm install -g bower
pip install django-bower

edit your settings.py

add to INSTALLED_APPS:

'djangobower',

Add staticfinder to STATICFILES_FINDERS:

'djangobower.finders.BowerFinder',

Specify the path to the components root (you need to use an absolute path):

BOWER_COMPONENTS_ROOT = '/PROJECT_ROOT/components/'

Add the following Bower dependencies for scheduler:

BOWER_INSTALLED_APPS = (
    'jquery',
    'jquery-ui',
    'bootstrap'
)

Last step, install bower dependencies with:

./manage.py bower install

Remember to execute "python manage.py collectstatic"

Features

  • one-time and recurring events
  • calendar exceptions (occurrences changed or cancelled)
  • occurrences accessible through Event API and Period API
  • relations of events to generic objects
  • ready to use, nice user interface
  • view day, week, month, three months and year

Configuration

Full Calendar examples

Full calendar

Monthly view (static)

Daily view (static)

Metrics

Throughput Graph

Optional Settings

FIRST_DAY_OF_WEEK

This setting determines which day of the week your calendar begins on if your locale doesn't already set it. Default is 0, which is Sunday.

OCCURRENCE_CANCEL_REDIRECT

This setting controls the behavior of Views.get_next_url. If set, all calendar modifications will redirect here (unless there is a next set in the request.)

SHOW_CANCELLED_OCCURRENCES

This setting controls the behavior of Period.classify_occurrence. If True, then occurrences that have been cancelled will be displayed with a css class of canceled, otherwise they won't appear at all.

Defaults to False

CHECK_EVENT_PERM_FUNC

This setting controls the callable used to determine if a user has permission to edit an event or occurrence. The callable must take the object (event) and the user and return a boolean.

Default:

    check_edit_permission(ob, user):
        return user.is_authenticated

If ob is None, then the function is checking for permission to add new events

CHECK_CALENDAR_PERM_FUNC

This setting controls the callable used to determine if a user has permission to add, update or delete an events in specific calendar. The callable must take the object (calendar) and the user and return a boolean.

Default:

    check_edit_permission(ob, user):
        return user.is_authenticated

GET_EVENTS_FUNC

This setting controls the callable that gets all events for calendar display. The callable must take the request and the calendar and return a QuerySet of events. Modifying this setting allows you to pull events from multiple calendars or to filter events based on permissions

Default:

    get_events(request, calendar):
        return calendar.event_set.all()

SCHEDULER_PREVNEXT_LIMIT_SECONDS

This settings allows to set the upper and lower limit in calendars navigation. Value is in seconds.

Default (two years): 62208000

Contributing

Tests

To run tests on all supported versions of Django and Python, use tox:

$ tox

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-scheduler-0.10.1.tar.gz (119.7 kB view details)

Uploaded Source

Built Distribution

django_scheduler-0.10.1-py3-none-any.whl (121.0 kB view details)

Uploaded Python 3

File details

Details for the file django-scheduler-0.10.1.tar.gz.

File metadata

  • Download URL: django-scheduler-0.10.1.tar.gz
  • Upload date:
  • Size: 119.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.4

File hashes

Hashes for django-scheduler-0.10.1.tar.gz
Algorithm Hash digest
SHA256 f319bad4ea30791b83f8d4eecbf4b3091b3aad52aba8080861fa979164a2ab6a
MD5 979376774b7676086f44d22158a3e701
BLAKE2b-256 d07ef184d736766f0d976bed980dac89bf9aecb367221370d897273fb096967a

See more details on using hashes here.

File details

Details for the file django_scheduler-0.10.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_scheduler-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b3eb31217cc2f29c582389ad3f69436176fee75088f477f81c68603fec063f95
MD5 f5e96a83fe26727c135a692b4296450d
BLAKE2b-256 b0164f71acedfdc8053423c09fcd014b779004b9c367d3e0d7af96c1d28a5f27

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page