Skip to main content

Django utility wrapping dateutil.rrule

Project description

django-recurrence

Build Status

django-recurrence is a utility for working with recurring dates in Django. Documentation is available at https://django-recurrence.readthedocs.org/.

It provides:

  • Recurrence/Rule objects using a subset of rfc2445 (wraps dateutil.rrule) for specifying recurring date/times;
  • RecurrenceField for storing recurring datetimes in the database;
  • JavaScript widget.

RecurrenceField provides a Django model field which serializes recurrence information for storage in the database.

For example - say you were storing information about a university course in your app. You could use a model like this:

import recurrence.fields

class Course(models.Model):
    title = models.CharField(max_length=200)
    start = models.TimeField()
    end = models.TimeField()
    recurrences = recurrence.fields.RecurrenceField()

You'll notice that I'm storing my own start and end time. The recurrence field only deals with recurrences not with specific time information. I have an event that starts at 2pm. Its recurrences would be "every Friday". For this to work, you'll need to put the recurrence application into your INSTALLED_APPS

Running the tests

Our test coverage is currently fairly poor (we're working on it!), but you can run the tests by making sure you've got the test requirements installed:

pip install -r requirements_test.txt

Once you've done that, you can run the tests using:

make test

You can generate a coverage report by running:

make coverage

You can run tests on multiple versions of Python and Django by installing tox (pip install tox) and running:

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-recurrence-1.10.1.tar.gz (110.0 kB view details)

Uploaded Source

Built Distribution

django_recurrence-1.10.1-py3-none-any.whl (106.8 kB view details)

Uploaded Python 3

File details

Details for the file django-recurrence-1.10.1.tar.gz.

File metadata

  • Download URL: django-recurrence-1.10.1.tar.gz
  • Upload date:
  • Size: 110.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

File hashes

Hashes for django-recurrence-1.10.1.tar.gz
Algorithm Hash digest
SHA256 ac2a7c74001a55268928a6963ca73c65f190bdc007681728b956df750b284433
MD5 bee20ebed2a0db1fcbccd8fca5b02457
BLAKE2b-256 8fe5031823479610d2aeb176a4bd659f4851cda70fb38081357c817458b4e418

See more details on using hashes here.

Provenance

File details

Details for the file django_recurrence-1.10.1-py3-none-any.whl.

File metadata

  • Download URL: django_recurrence-1.10.1-py3-none-any.whl
  • Upload date:
  • Size: 106.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

File hashes

Hashes for django_recurrence-1.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cf865ec07e60bc4203ce09d849b03e1e506a36c56337962d95cd558a7c59b707
MD5 40186ab2d73e7d991c88a97e9847e923
BLAKE2b-256 cd84cfd259adfe95c4e5df55d90828e6ed3dd80512570520fb4814e48b258671

See more details on using hashes here.

Provenance

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