Django utilities for publishing events as a calendar
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci
pinax Remove local template Jan 27, 2018
.coveragerc
.gitignore
AUTHORS
CONTRIBUTING.md
LICENSE
MANIFEST.in
Makefile
README.md
runtests.py
setup.cfg
setup.py
tox.ini

README.md

Pinax Calendars

CircleCI Codecov

Table of Contents

About Pinax

Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable Django apps, themes, and starter project templates. This collection can be found at http://pinaxproject.com.

pinax-calendars

Overview

pinax-calendars, formerly named kairios provides utilities for publishing events as a calendar.

At the moment, it just provides a visual calendar (both large and small) showing which days have events and optionally linking to a day detail page.

There is a demo project that you can clone and run to see pinax-calendars in action.

Supported Django and Python versions

Django \ Python 2.7 3.4 3.5 3.6
1.11 * * * *
2.0 * * *

Documentation

Installation

Install the package:

$ pip install pinax-calendars

Add pinax.calendars to your INSTALLED_APPS setting:

    INSTALLED_APPS = [
        # other apps
        "pinax.calendars",
    ]

Usage

Using pinax-calendars is a combination of setting up a view that can paginate through months, adapting a queryset of date-based data, and using a template tag.

The end result is to render a month-based view of all your events.

Example:

{% load pinax_calendars_tags %}

{% calendar events %}

where events implements the following protocol:

events.day_url(year, month, day, has_event, **kwargs)

Returns a link to the page for the given day or None. has_event is a boolean telling this method whether there is an event on the day or not so you can choose whether a day without an event should link or not.

events.month_url(year, month, **kwargs)

Returns a link to the page for the given month or None.

events_by_day(year, month, **kwargs)

Returns a dictionary mapping day number to a list of events on that day.

Note that all methods take additional keyword arguments used for calculating the return value.

View Mixins

There are two mixins to make it easier to write monthly (pinax.calendars.mixins.MonthlyMixin) and daily (pinax.calendars.mixins.DailyMixin) views.

Monthly Mixin

The MonthlyMixin will add month_kwarg_name and year_kwarg_name properties to the view and default to "month" and "year" respectively. These should be set to match the url pattern for the view.

During the dispatch() phase of the view lifecycle, these parameters will be fetched and if they are present, will be coalesced into a datetime.date object passing 1 for the day attribute. If month or year are not found in the url, then timezone.now().date() will be used. Either one of these options will set the date property of the view. This is done so you can provide a default view that doesn't have the year and month in the url without having to redirect.

This date property can then be used in your view to pass to the template context as the {% calendars %} template tag will need the date you are viewing.

Daily Mixin

The DailyMixin will add month_kwarg_name, year_kwarg_name, and day_kwargs_name properties to the view and default to "month", "year", "day" respectively. These should be set to match the url pattern for the view.

During the dispatch() phase of the view lifecycle, these parameters will be fetched and coalesced into a datetime.date object which gets set to self.date on the view.

This date property can then be used in your view to pass to the template context as well as filter your event queryset for just that date.

Event Queryset Adapter

We use a basic adapter pattern to provide the calendar tag with some things it needs. There is a base adapter provided in pinax.calendars.adapters.EventAdapter but is designed in a way to override parts of it as needed for your use case.

The adapter is providing three functions:

  1. computing a daily url, used to link to a daily detail view
  2. computing a monthly url, used for monthly pagination
  3. structuring event queryset data in a way that can be iterated over in the template include.

All three methods receive extra kwargs that are passed directly from the template tag in case you need to do something custom in your site's integration of pinax-calendars.

Daily URL

By default, EventAdapter.day_url_name is set to "daily" and reverse() uses year, month, and day arguments to construct the url. This is done in the EventAdapter.day_url method which also receives a has_event parameter. The default implementation of day_url() will only return a URL if has_event is True.

Monthly URL

By default, EventAdapter.month_url_name is set to "monthly" and reverse() uses year, and month arguments to construct the url. This is done in the EventAdapter.month_url method.

Events By Day

The EventAdapter.events_by_day method takes year and month arguments. By default, it will construct filter arguments based on the EventAdapter.date_field_name property, which defaults to "date", to filter the self.queryset by year and month (e.g. date__year=year, date__month=month).

It will then collect events into date buckets and return a dictionary of lists.

Template Tag

The template tag is pretty simple. It expects an adapted queryset along with the date representing the month that you are wanting to display. If no date is supplied, then it will assume that you mean the current month. You can also optionally supply a timezone in which case timezone.now will be localized to that timezone for the purposes of displaying the current month.

Example:

{% load pinax_calendars_tags %}

{% block body %}
    {% calendar events %}
{% endblock %}

Templates

Default templates are provided by the pinax-templates app in the calendars section of that project.

Reference pinax-templates installation instructions to include these templates in your project.

View live pinax-templates examples and source at Pinax Templates!

Customizing Templates

Override the default pinax-templates templates by copying them into your project subdirectory pinax/calendars/ on the template path and modifying as needed.

For example if your project doesn't use Bootstrap, copy the desired templates then remove Bootstrap and Font Awesome class names from your copies. Remove class references like class="btn btn-success" and class="icon icon-pencil" as well as bootstrap from the {% load i18n bootstrap %} statement. Since bootstrap template tags and filters are no longer loaded, you'll also need to update {{ form|bootstrap }} to {{ form }} since the "bootstrap" filter is no longer available.

calendar.html

Rendered by the {% calendar %} template tag. The template uses semantic markup to make styling easy and relatively free of framework bias.

The entire block is wrapped in a div.calendar, there is a header with some nav, followed by a table (table.calendar-table for which there is a bit of bootstrap style included below).

div.calendar
  div.calendar-heading
    h3.calendar-title
    div.calendar-nav
      a[href=prev]
      span.calendar-date
      a[href=next]
  div.calendar-body
    table.calendar-table
      tr
        td.day.noday
        - or -
        td.day.[day-has-events|day-no-events]
          a.day-number
          - or -
          span.day-number
          div.day-event-list
            div.day-event

Style

If you use pinax-templates calendar.html template, you can add this bit of SCSS to your project (if you are building upon Bootstrap) to render a full width monthly calendar with responsive squares for each day:

.calendar-table {
    @extend table;
    td {
        width: 14.2vw;
        height: 14.2vmin;
    }
}

Change Log

2.0.4

  • Remove local template in favor of pinax-templates

2.0.3

  • fix reverse import
  • add tests

2.0.2

  • Update requirements, add django>=1.11
  • Update sorting config
  • Update documentation
  • Remove doc build

2.0.1

  • fix setup.py LONG_DESCRIPTION for PyPi

2.0.0

  • Add Django 2.0 compatibility testing
  • Drop Django 1.8, 1.9, 1.10 and Python 3.3 support
  • Convert CI and coverage to CircleCi and CodeCov
  • Add PyPi-compatible long description
  • Move documentation to README.md

1.1.0

  • Added timezone support for calendar PR #5

1.0.0

  • Added docs

0.6

  • Added adapters.py and mixins.py

0.5

  • Donated to Pinax from Eldarion
  • Renamed from kairios to pinax-calendars

Contribute

For an overview on how contributing to Pinax works read this blog post and watch the included video, or read our How to Contribute section. For concrete contribution ideas, please see our Ways to Contribute/What We Need Help With section.

In case of any questions we recommend you join our Pinax Slack team and ping us there instead of creating an issue on GitHub. Creating issues on GitHub is of course also valid but we are usually able to help you faster if you ping us in Slack.

We also highly recommend reading our blog post on Open Source and Self-Care.

Code of Conduct

In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a code of conduct. We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.

Connect with Pinax

For updates and news regarding the Pinax Project, please follow us on Twitter @pinaxproject and check out our Pinax Project blog.

License

Copyright (c) 2012-2018 James Tauber and contributors under the MIT license.