Installing Orbited 0.5

Orbited is written in Python and requires Python 2.4 or newer. Orbited also requires Twisted, which it installs automatically on most platforms (and is otherwise installed trivially). The 0.5 series is backwards-compatible as far as the 0.3 series, and will run out of the box with any existing Orbited application. Additionally, Orbited 0.5 enables a revolutionary interaction model centered around the TCPSocket.

Python

First of all, let's install Python. Download and run the installer for your system, and you'll be good to go.

Installers: Windows OSX Linux

For more detailed instructions, please refer to python.org's help page.

Twisted

THIS STEP IS ONLY NECESSARY FOR WINDOWS. If you are running some other platform, SKIP THIS STEP.

1. Download and run the Twisted installer

For more detailed instructions, please refer to Twisted's download guide.

setuptools

Although it is not required, setuptools is by far the easiest way to get Orbited running.

1. Download ez_setup.py

2. Go to a command line, navigate to the directory containing ez_setup.py, and type:

python ez_setup.py setuptools

Orbited

You're almost done! Now all you have to do is install Orbited, itself:

Go to a command line and type:

easy_install orbited

To make sure the installation was successful, run this simple test:

Enter your Python interpreter:

python

See whether Orbited loads:

import orbited

If you don't see an error, it worked! Now, check out CherryChat, your first Orbited application.

Post-Installation Notes

Orbited encodes data as JSON, using a library called demjson. If you are looking for ways to speed up your project, try installing a super-fast C-based JSON library such as cjson or simplejson. Remember easy_install? It works here, too:

easy_install cjson

easy_install simplejson