Skip to main content

A Django calendaring application

Project description

https://github.com/dakrauth/django-swingtime/workflows/Test/badge.svg https://badge.fury.io/py/django-swingtime.svg
Version:

2.1.0

Demo:

https://nerdfog.com/swingtime/

Download:

https://pypi.org/project/django-swingtime/

Source:

https://github.com/dakrauth/django-swingtime

Documentation:

http://dakrauth.github.io/django-swingtime/

Description

Swingtime is a Django application similar to a stripped-down version of iCal for Mac OS X or Google Calendar.

Swingtime provides a models.Event model that acts as metadata container for one or more models.Occurrence objects, which describe specific start and end times. Alternatively, there abstract, base models that can be used. See the provide demo app for examples.

Swingtime relies heavily upon both the datetime standard library package and the dateutil package, featuring direct support for the dateutil.rrule interface to create occurrences.

A fairly simple example:

>>> from datetime import *
>>> from swingtime import models as swingtime
>>> et = swingtime.EventType.objects.create(abbr='work', label='Work Related Events')
>>> evt = swingtime.Event.objects.create(
...     title='New TPS Cover Sheet',
...     description='Kiss off, Lumbergh!',
...     event_type=et
... )
>>> evt.add_occurrences(datetime(2018,3,18,16), datetime(2018,3,18,16,15), count=5)
>>> for o in evt.occurrence_set.all():
...     print(o)
...
New TPS Cover Sheet: 2018-03-18T16:00:00
New TPS Cover Sheet: 2018-03-19T16:00:00
New TPS Cover Sheet: 2018-03-20T16:00:00
New TPS Cover Sheet: 2018-03-21T16:00:00
New TPS Cover Sheet: 2018-03-22T16:00:00

A bit more elaborate example, using the the convenience function models.create_event:

>>> # pay day is the last Friday of the month at 5pm
>>> evt = swingtime.create_event(
...     'Pay day',
...     ('pay', 'Payroll'), # alternate means to add EventType on the fly
...     freq=rrule.MONTHLY,
...     byweekday=rrule.FR(-1),
...     until=datetime(2013,8,1),
...     start_time=datetime(2013,4,1,17)
... )
>>> for o in evt.occurrence_set.all():
...     print(o)
...
Pay day: 2013-04-26T17:00:00
Pay day: 2013-05-31T17:00:00
Pay day: 2013-06-28T17:00:00
Pay day: 2013-07-26T17:00:00

Demo

To view a demo, click here.

To run a local demo using Docker, do the following:

$ docker build -t swingtime .
$ docker run -p 8000:80 swingtime:latest

And browse to localhost:8001.

Alternatively:

python -m venv .venv
./.venv/bin/activate
pip install -e ".[dev]"
cd demo
./manage.py migrate
./manage.py runserver

And browse to localhost:8000.

Features

  • Support for adding complex event occurrences via dateutil

  • Ready-made forms.MultipleOccurrenceForm for handling complex input

  • Daily, monthly, and annual view functions

  • Daily, monthly, and annual view classes.

  • Grid-based daily view generator, complete with alternating or sequential EventType CSS-class handling

  • Slightly better than average documentation, a few test cases, and commented code

  • Built-in demo project / application

Requirements

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_swingtime-2.1.0.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

django_swingtime-2.1.0-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

Details for the file django_swingtime-2.1.0.tar.gz.

File metadata

  • Download URL: django_swingtime-2.1.0.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for django_swingtime-2.1.0.tar.gz
Algorithm Hash digest
SHA256 021bdd8194ef6751e0e9fff791323d0e4fea5b4fc0ba4ca5d53879aa222fef98
MD5 67cdfc6c9273d22f1120ba0126b4ea48
BLAKE2b-256 0b2baab1dc5ab12284c08974d3a2a73f13ba91ba4a9ed924519af91003716f26

See more details on using hashes here.

File details

Details for the file django_swingtime-2.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_swingtime-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 562e4c905e4e555985d5c26c234c6dcd3933c07383c336e6458d6c2326ea99a5
MD5 87ba37e187eeb800fc02843f6c737db0
BLAKE2b-256 a630c081a04d02ee18f562a9d2d80f5429c3fb4001296ce489d1f3b8cb89eff0

See more details on using hashes here.

Supported by

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