Metadata-Version: 1.1
Name: whoarder
Version: 0.2
Summary: whoarder converts your Kindle's 'My Clippings.txt' file to a more pleasant, sortable, filterable HTML file
Home-page: https://github.com/ronjouch/whoarder
Author: Ronan Jouchet
Author-email: ronan@jouchet.fr
License: LICENSE.txt
Description: whoarder
        ========
        
        **whoarder** converts your Kindle's ``My Clippings.txt`` file to a more pleasant, sortable, filterable HTML file:
        
        .. image:: https://github.com/ronjouch/whoarder/raw/master/whoarder-screenshot.png
        
        Installation & Requirements
        ---------------------------
        
        To install, just ``pip install whoarder`` . Requirements are:
        
        * Python 3.3 (so far I only tested with 3.3 on Linux, tests and patches to increase compatibility very welcome)
        
        * The ``jinja2`` and ``chardet2`` modules (automatically handled as ``setup.py`` dependencies)
        
        * Only tested on a ``My Clippings.txt`` file produced by a Kindle Paperwhite (ok/ko reports for other devices and test data welcome through `GitHub <https://github.com/ronjouch/whoarder/pulls>`_).
        
          - Kindle Fire & Kindle Fire HD are not supported, since they do note create the ``My Clippings.txt`` file. If you know where to dig that data for those versions, patches welcome.
        
        Usage
        -----
        
        **Command-line**:
        
        Run ``whoarder /path/to/My Clippings.txt [destination]`` . If ``destination`` is omitted, the output HTML will be written in the same place (overwriting any pre-existing HTML).
        
        **As module**::
        
            from clippings import Clippings
            clippings = Clippings(args.source, args.destination)  # contains a 'clippings' dict containing the information
            clippings.export_to_html()  # exports as HTML
        
        **Tests**:
        
        Test data and ``unittest``-based unit tests are in the ``tests`` folder.
        
        Similar Software
        ----------------
        
        * Web services
        
          - `Clippings Converter <http://www.clippingsconverter.com/>`_
        
          - `Clipper <http://www.claybavor.com/clipper/>`_
        
        * Offline
        
          - (PHP) `kindle-split-by-book <https://gist.github.com/elvisciotti/1783585>`_
        
        License and contact
        -------------------
        
        Licensed under the BSD-new license, 2013 (see ``LICENSE.txt``), `ronan@jouchet.fr <mailto:ronan@jouchet.fr>`_ / `@ronjouch <https://twitter.com/ronjouch>`_
        
Keywords: amazon kindle transform notes highlights clippings html
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
