Installing RapidSMS

Note

RapidSMS depends on the Django web framework. If you’re new to Django, we recommend reading through the Django installation instructions before installing RapidSMS.

The recommended way to install RapidSMS is with Pip (since RapidSMS is available on PyPI):

pip install rapidsms

Starting a New RapidSMS Project

Installing the RapidSMS project template

If you’re starting a new RapidSMS project, you can use the RapidSMS project template. The template is a custom project template.

To use the project template, first make sure you have the latest version of Django installed:

pip install django

Now you can use the startproject management command with the template option. You just need to specify your project name at the end of the command:

django-admin.py startproject --template=https://github.com/rapidsms/rapidsms-project-template/zipball/release-0.21.1 --extension=py,rst my_project_name

This will create a new project using the name you specified. Inside your project, you’ll find a README.rst file with instructions to setup your project.

Installing the latest development version

The latest development version is available in our Git repository. Get it using this shell command, which requires Git:

git clone https://github.com/rapidsms/rapidsms.git

You can also download a zipped archive of the development version.