Skip to content

Documentation

Bitcaster-django is a Django app that integrates your project with Bitcaster, the system-to-user signal-to-message notification system: it lets you trigger remote Bitcaster events from local, database-configured event names and manage Bitcaster users from your Django application.

Dependencies

  • Python 3.10 or later
  • Django 4.2 or any later version supporting your Python version of choice.

Installation

  • Install bitcaster-django using your package manager of choice, e.g. Pip: bash pip install bitcaster-django

  • Add bitcaster-django to INSTALLED_APPS in your config/settings.py file: python INSTALLED_APPS = ( ... "bitcaster_django", ... )

  • Configure the app with the BITCASTER dictionary in your settings (see Getting started).

  • Run the migrations to create the event configuration table: bash python manage.py migrate

  • Check that your configuration is valid: bash python manage.py check

See Getting started for the configuration reference and usage, and the demo application for a runnable playground exercising every feature from the browser.

Bug reports and requests for enhancements

Please open an issue on the project's issue tracker on GitHub.

Contributing to the project

See the contribution guide.

Licensing

Distributed under the KRM Source License, Version 1.1, Apache 2.0 Future License: see LICENSE.md.