Shiori is bookmarking tool based on Web UI and JSON REST API

What's "Shiori"?

This tool provides web UI and JSON REST API for bookmarking. The API depends on django REST framework, Web UI depends on it's API and Backbone.js. The user registeration and login of this tool uses OpenID.

"Shiori" is means a bookmark in Japanese. It is written "栞" in Kanji, this caracter is 0x681E in Unicode.

https://secure.travis-ci.org/mkouhei/shiori.png?branch=devel

https://coveralls.io/repos/mkouhei/shiori/badge.png?branch=devel

Requirements

Python 2.7
Django (>= 1.6)
Django REST framework (>= 2.3.12)
shortuuid (== 0.3.2) (this is work-around for the garbage (v0.4 not released) is left in the PyPI.)
django-shortuuidfield (>= 0.1.2)
django-jsonfield
python-openid (>= 2.2.5)
django_openid_auth (>= 0.5)
south
netaddr
lxml
defusedxml
requests
celery
jQuery (>= 2.1.1)
underscore.js (>= 1.5.2)
backbone.js (>= 1.1.0)
JSON in JavaScript
Twitter bootstrap (>= 3.2.0)

Recommends

MySQL
python-mysqldb
RabbitMQ

Setup

Install Debian packages that Shiori depends on

Shiori depends on as following.:

$ sudo apt-get install python-django python-djangorestframework \
python-django-shortuuidfield python-django-auth-openid python-celery \
python-lxml python-defusedxml python-netaddr python-django-south \
libjs-jquery libjs-underscore libjs-json \
libxml2-dev libxslt1-dev python-requests python-dev libpython2.7-dev \
python-django-jsonfield

Update and rebuild libjs-backbone

The version of libjs-backbone in Sid is 0.9.2-4 at 2014-02-08. (1) So you must rebuild from source package currently.:

$ sudo apt-get build-dep libjs-backbone
$ apt-get source libjs-backbone
$ cd backbone-0.9.2
$ uscan
$ uupdate ../1.x.x.tar.gz 1.x.x
$ cd ../backbone-1.x.x
$ debuild -us -uc
$ sudo dpkg -i ../libjs-backbone_1.x.x-1_all.deb

http://packages.qa.debian.org/b/backbone.html

Install Shiori

from source

$ git clone https://github.com/mkouhei/shiori.git
$ cd shiori
$ sudo python setup.py install

from PyPI

$ pip install shiori

Workaround django-auth-openid someproblems

django-auth-openid is not support django 1.5 over now, then you should use source debian package, and must apply some patches.:

$ apt-get source python-django-auth-openid
$ cd django-openid-auth-0.5
$ python setup.py install

Make symlinks of JavaScript Libraries

Shiori has no depended on JavaScript libraries, so make symlinks. Executute miscs/setup.sh script.:

$ cd /path/to/lib/python2.7/site-packages/shiori-0.x.x-py2.7.egg/shiori/static
$ sh ../miscs/setup.sh
$ ls -n
total 8
lrwxrwxrwx 1 1000 1000   30 Feb  9 09:26 backbone -> /usr/share/javascript/backbone
drwxr-xr-x 2 1000 1000 4096 Feb  9 06:49 css
lrwxrwxrwx 1 1000 1000   34 Feb  9 09:26 twbs -> /usr/share/twitter-bootstrap/files
lrwxrwxrwx 1 1000 1000   28 Feb  9 09:26 jquery -> /usr/share/javascript/jquery
drwxr-xr-x 2 1000 1000 4096 Feb  9 06:49 js
lrwxrwxrwx 1 1000 1000   26 Feb  9 09:26 json -> /usr/share/javascript/json
lrwxrwxrwx 1 1000 1000   32 Feb  9 09:26 underscore -> /usr/share/javascript/underscore

Configuration

You must change some values in shiori/core/settings.py.

SECRET_KEY
DEBUG
ALLOWED_HOSTS
DATABASES

Execute syncdb.:

$ python /path/to/shiori/manage.py syncdb

Run server.:

$ python /path/to/shiori/manage.py runserver

Start Celery.:

$ celery -A shiori.core worker --beat -l info

Development

You copy pre-commit hook scripts after git clone.:

$ cp -f utils/pre-commit.txt .git/hooks/pre-commit

Next install python 2.7 later and setuptools, pytest, pep8. Below way is for Debian GNU/Linux Sid system.:

$ sudo apt-get install python python-setuptools python-pytest pep8 libxml2-dev libxml2 python-dev closure-linter python-tox

Then checkout 'devel' branch for development, commit your changes. Before pull request, execute git rebase.

mkouhei/shiori