Welcome to pypo’s documentation!¶

About Pypo¶

Pypo is a self hosted bookmarking service like Pocket. There also is a rudimentary android application and firefox extension to add and view the bookmarks.

It’s main components are built with:

Python 3
Postgresql
Django
readability-lxml
Whoosh
django-haystack
django-taggit
tld
South
requests
djangorestframework
py.test
bleach

Documentation¶

Full documentation can be found at readthedocs

Features¶

Adding links and fetch their summaries and titles
Links can have multiple tags
Search by title, url and tags
Filter by tags

Installation¶

Create a virtualenv and

$ pip install -r requirements.txt
$ pip install -e .

Setup a postgresql db
You can overwrite the default settings by creating a settings_local.py next to pypo/settings.py . Do not directly edit the settings.py.
Install js modules with bower

$ npm install -g bower
$ bower install

Install yuglify for js and css minifiy

$ npm install -g yuglify

Setup the database

$ ./manage.py syncdb
$ ./manage.py migrate

Add a superuser

$ ./manage.py createsuperuser

Host the application, see Deploying Django with WSGI
Create normal users with the admin interface /admin

Deploying¶

There is a fab file you can customize to you liking. It creates a virtualenv, sets up the directory structure and checks your current local commit out on the target machine.

Requirements status¶

License¶

This project is licensed under the terms of the Apache License version 2. See COPYING.txt for details.