Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Build SMS applications with Python
branch: master

This branch is 1174 commits behind rapidsms:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib/rapidsms
.gitattributes
.gitignore
.gitmodules
AUTHORS
LICENSE
MANIFEST.in
README.rst
pip-requires.txt
setup.py

README.rst

RapidSMS

RapidSMS is a free and open source framework for building interactive SMS applications, which integrates tightly with Django to provide a rich reporting interface. It was created by the Innovation Team at UNICEF, and is under development by the RapidSMS Team.

Please Note

  1. The very old RapidSMS codebase (AKA Tusker) that was living in rapidsms has been moved to rapidsms/rapidsms-legacy. If your clone or fork is still in use, you should update your repository's remote/origin.
  2. The combined repository of the contents of rapidsms-core-dev and rapidsms-contrib-apps-dev has replaced the old codebase in rapidsms.
  3. The search and training apps that were in rapidsms-contrib-apps-dev have been removed and are now submodules of rapidsms-community-apps-dev.
  4. The rapidsms-core-dev and rapidsms-contrib-apps-dev repositories will remain unchanged until the 1.0 release, but should now be considered deprecated.
  5. The PyPi package will now install from rapidsms.
This note will be removed from this README once RapidSMS 1.0 arrives.

Installing

RapidSMS is best installed via PyPi. To install the latest stable-ish version:

$ pip install rapidsms

Alternatively, to install the development version from GitHub:

$ pip install git+git://github.com/rapidsms/rapidsms.git#egg=RapidSMS

The RapidSMS project skeleton is identical to the Django project skeleton, with a few of our settings added. To quickly spawn a new project, we've bundled a wrapper around django-admin.py:

$ rapidsms-admin.py startproject myproject

The runrouter management command starts the router, sends and receives SMS (and other short messages) via the configurable backends:

$ python manage.py runrouter

Getting Help

Right now, RapidSMS isn't very well documented. We're working on that on the RapidSMS wiki, but you may find more useful information on the mailing list for the time being.

Dependencies

License

RapidSMS is free software, available under the BSD license.

Bugs

Please file bugs on the RapidSMS issue tracker, and/or submit a pull request.

Something went wrong with that request. Please try again.