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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: django-recurrence-1.10.0.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.0.tar.gz
Algorithm Hash digest
SHA256 37a78a902381102b311a77efd7b17b07fa6629980cb14fe1578d4fc14988e143
MD5 227f163569226f0e70ac471e4fa56785
BLAKE2b-256 aa1c159a42747228963989344d9ebc0aa02b73ec8bb2d4230798fb7a052397d1

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: django_recurrence-1.10.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b42c705be041cf23a9e633053edb068d2f1317f3829e4b49c8004c67cdfd8ab1
MD5 253c874fd78e4d64421c02f28d6fea5f
BLAKE2b-256 a68c9afec6d29fe6b4a91d9f4ae948231ed2a6ed121d5d8231e7779373729f4f

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