https://github.com/audax/pypo

Pypo is a self hosted bookmarking service like Pocket, implemented in Python with django
https://github.com/audax/pypo

Last synced: 15 days ago
JSON representation

Pypo is a self hosted bookmarking service like Pocket, implemented in Python with django

• Host: GitHub
• URL: https://github.com/audax/pypo
• Owner: audax
• License: other
• Created: 2013-11-25T19:43:44.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2016-04-17T15:58:25.000Z (over 8 years ago)
• Last Synced: 2024-08-01T16:44:40.519Z (3 months ago)
• Language: Python
• Homepage:
• Size: 661 KB
• Stars: 29
• Watchers: 8
• Forks: 7
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: COPYING.txt

Awesome Lists containing this project

README

        
About Pypo

==========

|Build Status|

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

------------

1. Create a virtualenv and

.. code-block:: bash

   $ pip install -r requirements.txt

   $ pip install -e .

2. Setup a postgresql db

3. You can overwrite the default settings by creating a

   settings\_local.py next to pypo/settings.py . Do not directly edit

   the settings.py.

4. Install js modules with bower

.. code-block:: bash

   $ npm install -g bower

   $ bower install

5. Install yuglify for js and css minifiy

.. code-block:: bash

   $ npm install -g yuglify

6. Setup the database

.. code-block:: bash

   $ ./manage.py syncdb

   $ ./manage.py migrate

7. Add a superuser

.. code-block:: bash

   $ ./manage.py createsuperuser

8. Host the application, see `Deploying Django with WSGI`_

9. 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

------------------

 |Requirements Status|

License

-------

This project is licensed under the terms of the Apache License version

2. See COPYING.txt for details.

.. _Pocket: http://www.getpocket.com

.. _Deploying Django with WSGI: https://docs.djangoproject.com/en/1.6/howto/deployment/wsgi/

.. _readthedocs: http://pypo.readthedocs.org/

.. |Build Status| image:: https://travis-ci.org/audax/pypo.png?branch=master

    :target: https://travis-ci.org/audax/pypo

.. |Requirements Status| image:: https://requires.io/github/audax/pypo/requirements.png?branch=master

   :target: https://requires.io/github/audax/pypo/requirements/?branch=master

   :alt: Requirements Status