Installation guide

Before installing django-soapbox, you’ll need to have a copy of Django already installed. For information on obtaining and installing Django, consult the Django download page, which offers convenient packaged downloads and installation instructions.

The 1.5 release of django-soapbox supports Django 1.8, 1.10, and 1.11 on the following Python versions (matching the versions supported by Django itself):

  • Django 1.8 supports Python 2.7, 3.3, 3.4, and 3.5.
  • Django 1.10 supports Python 2.7, 3.4, and 3.5.
  • Django 1.11 supports Python 2.7, 3.4, 3.5, and 3.6

Important

Python 3.2

Although Django 1.8 supported Python 3.2 at the time of its release, the Python 3.2 series has reached end-of-life, and as a result support for Python 3.2 has been dropped from django-soapbox.

Normal installation

The preferred method of installing django-soapbox is via pip, the standard Python package-installation tool. If you don’t have pip, instructions are available for how to obtain and install it. If you’re using Python 2.7.9 or later (for Python 2) or Python 3.4 or later (for Python 3), pip came bundled with your installation of Python.

Once you have pip, type:

pip install django-soapbox

Installing from a source checkout

If you want to work on django-soapbox, you can obtain a source checkout.

The development repository for django-soapbox is at <https://github.com/ubernostrum/django-soapbox>. If you have git installed, you can obtain a copy of the repository by typing:

git clone https://github.com/ubernostrum/django-soapbox.git

From there, you can use normal git commands to check out the specific revision you want, and install it using pip install -e . (the -e flag specifies an “editable” install, allowing you to change code as you work on django-soapbox, and have your changes picked up automatically).

Configuration and use

Once you have Django and django-soapbox installed, check out the usage overview to see how to start using messages on your site.