Installation

Installation

Stable release

To install django-recurring, run this command in your terminal:

$ pip install django-recurring

This is the preferred method to install django-recurring, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

Django Configuration

After installing django-recurring, you need to add it to your Django project’s settings:

  1. Add ‘recurring’ to your INSTALLED_APPS in your Django settings file:

    INSTALLED_APPS = [
        ...
        'recurring',
        ...
    ]
    
  2. If you want to export to ical, you can optionally configure the PRODID value via the following setting:

    ICAL_PROD_ID="-//My Company//My Product//EN"
    
  3. Run migrations to create the necessary database tables:

    $ python manage.py migrate recurring
    
  4. Run collectstatic for prod releases:

    $ python manage.py collectstatic
    

From sources

The sources for django-recurring can be downloaded from the Github repo.

You can clone the public repository:

$ git clone git://github.com/boosh/django_recurring

Once you have a copy of the source, you can install it with:

$ cd django_recurring
$ pip install -e .

Compatibility

django-recurring is tested with:

  • Python 3.12.6+

  • Django 5.1+