Metadata-Version: 1.0
Name: digimarks
Version: 1.1.0
Summary: Simple bookmarking service, using a SQLite database to store bookmarks, supporting tags and automatic title fetching.
Home-page: https://github.com/aquatix/digimarks
Author: Michiel Scholten
Author-email: michiel@diginaut.net
License: Apache
Description: digimarks
        =========
        
        |PyPI version| |PyPI downloads| |PyPI license| |Code health|
        
        Simple bookmarking service, using a SQLite database to store bookmarks, supporting tags and automatic title fetching.
        
        
        Installation
        ------------
        
        From PyPI
        ~~~~~~~~~
        
        Assuming you already are inside a virtualenv:
        
        .. code-block:: bash
        
            pip install digimarks
        
        
        From Git
        ~~~~~~~~
        
        Create a new virtualenv (if you are not already in one) and install the
        necessary packages:
        
        .. code-block:: bash
        
            git clone https://github.com/aquatix/digimarks.git
            cd digimarks
            mkvirtualenv digimarks # or whatever project you are working on
            pip install -r requirements.txt
        
        
        Usage / example configuration
        -----------------------------
        
        Copy ``settings.py`` from example_config to the parent directory and
        configure to your needs (*at the least* change the value of `SYSTEMKEY`).
        
        Run digimarks as a service under nginx or apache and call the appropriate
        url's when wanted.
        
        Url's are of the form https://marks.example.com/<userkey>/<action>
        
        
        Bookmarklet
        ~~~~~~~~~~~
        
        To easily save a link from your browser, open its bookmark manager and create a new bookmark with as url:
        
        .. code-block:: javascript
        
            javascript:location.href='http://marks.example.com/1234567890abcdef/add?url='+encodeURIComponent(location.href);
        
        
        Creating a new user
        -------------------
        
        After having set up the ```settings.py``` as under Usage, you can add a new user, by going to this path on your digimarks server:
        
        /<secretkey>/adduser
        
        where `secretkey` is the value set in settings.SYSTEMKEY
        
        digimarks will then redirect to the bookmarks overview page of the new user. Please remember the user key (the hash in the url), as it will not be visible otherwise in the interface.
        
        If you for whatever reason would lose this user key, just either look on the console (or webserver logs) where the list of available user keys is printed on digimarks startup, or open bookmarks.db with a SQLite editor.
        
        
        Server configuration
        ~~~~~~~~~~~~~~~~~~~~
        
        * `vhost for Apache2.4`_
        * `uwsgi.ini`_
        
        
        What's new?
        -----------
        
        See the `Changelog`_.
        
        
        Attributions
        ------------
        
        'M' favicon by `Freepik`_.
        
        
        .. _digimarks: https://github.com/aquatix/digimarks
        .. _webhook: https://en.wikipedia.org/wiki/Webhook
        .. |PyPI version| image:: https://img.shields.io/pypi/v/digimarks.svg
           :target: https://pypi.python.org/pypi/digimarks/
        .. |PyPI downloads| image:: https://img.shields.io/pypi/dm/digimarks.svg
           :target: https://pypi.python.org/pypi/digimarks/
        .. |PyPI license| image:: https://img.shields.io/github/license/aquatix/digimarks.svg
           :target: https://pypi.python.org/pypi/digimarks/
        .. |Code health| image:: https://landscape.io/github/aquatix/digimarks/master/landscape.svg?style=flat
           :target: https://landscape.io/github/aquatix/digimarks/master
           :alt: Code Health
        .. _hook settings: https://github.com/aquatix/digimarks/blob/master/example_config/examples.yaml
        .. _vhost for Apache2.4: https://github.com/aquatix/digimarks/blob/master/example_config/apache_vhost.conf
        .. _uwsgi.ini: https://github.com/aquatix/digimarks/blob/master/example_config/uwsgi.ini
        .. _Changelog: https://github.com/aquatix/digimarks/blob/master/CHANGELOG.md
        .. _Freepik: http://www.flaticon.com/free-icon/letter-m_2041
        
Platform: UNKNOWN
