Pjuu is under very active development at this early stage in its life. A lot
may change between versions until we are happy with it :)

An open-source social networking application which runs https://pjuu.com.

This is an open source project released under the GNU AGPLv3 license. See LICENSE for more details or visit the official GNU page at http://www.gnu.org/licenses/agpl-3.0.html.

This is the primary code base for https://pjuu.com, the website is deployed directly from this respository.

The main goal of Pjuu as an application is privacy.

Pjuu is written in Python/Flask and uses Redis as the sole data store.

Getting started working on Pjuu or deploying it yourself is quite easy. We will only cover development here and the following documentation is for Debian 7 (Wheezy) Linux (we are big fans), this should work with Ubuntu also.

We are presuming a fresh installation, this will setup the environment:

Note: This will install Redis from wheezy-backports you may want to change this. Wheezy backports uses Redis version 2.8.6, you may already have a newer version, in Ubuntu for example.

Note: If you are struggling or would like to develop a feature which requires a newer version of Redis, checkout dotdeb.org it's pretty awesome.

$ sudo sh -c 'echo "deb http://ftp.uk.debian.org/debian wheezy-backports main" >> /etc/apt/sources.list'

$ sudo apt-get update

$ sudo apt-get install build-essentials python-dev python-setuptools

$ sudo apt-get install -t wheezy-backports redis-server

$ sudo easy_install virtualenv

$ git clone https://github.com/pjuu/pjuu.git

$ cd pjuu

$ virtualenv venv

$ source venv/bin/activate

$ pip install -r requirements.txt

Running the unit tests:

$ python run_tests.py

Running the unit tests with coverage:

$ coverage run --source=pjuu --omit=pjuu/wsgi.py,*.html,*.txt run_tests.py

Running the development server (CherryPy):

$ python run_server.py

You can view the site by visiting: http://localhost:5000

If you need to use any of the backend functions you can access the shell:

$ python run_shell.py

You can now play with the code base :)

We are open to all pull requests. Spend some time taking a look around, locate a bug, design issue or spelling mistake then send us a pull request :)

All software has bugs in and Pjuu is no different. These may have security implications. If you find one that you suspect could allow you to do something you shouldn't be able to please do not post it as an issue on Github. We would really appreciate it if you could send an e-mail to security@pjuu.com with the relevant details.

James Rand - illustrating our Otter logo :)