Metadata-Version: 1.1
Name: nvpy
Version: 0.9.0
Summary: A cross-platform simplenote-syncing note-taking app inspired by Notational Velocity.
Home-page: https://github.com/cpbotha/nvpy
Author: Charl P. Botha
Author-email: cpbotha@vxlabs.com
License: BSD
Description: ====
        nvPY
        ====
        
        nvpy is a simplenote-syncing note-taking tool inspired by Notational
        Velocity (and a little bit by nvALT too) on OSX and ResophNotes on
        Windows. It is significantly uglier, but it is cross-platform.  Yes,
        you heard right, you can run this on Linux (tested), Windows (tested)
        and OS X (lightly tested).
        
        It was written by Charl Botha, who needed a simplenote client on
        Linux and doesn't mind ugliness (that much).
        
        * nvpy lives happily at https://github.com/cpbotha/nvpy
        * For news and discussion, join the `public nvpy google group <https://groups.google.com/d/forum/nvpy>`_ or subscribe to its `RSS topic feed <https://groups.google.com/group/nvpy/feed/rss_v2_0_topics.xml>`_.
        
        DISCLAIMER
        ==========
        If nvpy blows up your computer, loses your job or just deletes all
        your notes, I am NOT liable for anything. Also see the liability
        clause at the end of the new BSD licence text in the COPYRIGHT file.
        
        That being said, I use nvpy daily on my own precious notes database
        and it hasn't disappointed me (yet).
        
        Screenshots and screencasts
        ===========================
        
        * Automatic hyperlinking on Linux (post 0.8.5):
        
        .. image:: https://github.com/cpbotha/nvpy/raw/master/images/nvpy_post0.8.5_screenshot.png
        
        
        * This is what nvpy looked like on Windows on May 23, 2012. Search bar at the top showing a regular expression, notes are sorted last modified first, continuously updated markdown preview in chrome behind the nvpy window: `nvpy_screenshot_20120523.jpg <https://github.com/cpbotha/nvpy/raw/master/images/nvpy_screenshot_20120523.jpg>`_.
        
        * Screencast of nvpy's inter-note linking: http://youtu.be/NXuVMZr31SI
        
        
        Installation
        ============
        
        To install the latest development version from github, do::
        
            pip install git+https://github.com/cpbotha/nvpy.git#egg=nvpy
        
        OR, to install the version currently on pypi, do::
        
            pip install nvpy
        
        OR, you can of course use easy\_install instead::
        
            easy_install nvpy
        
        github always has the latest development version, whereas I upload
        tagged snapshots (v0.3 for example) to pypi.
        
        For more detailed installation recipes, also for beginners, see
        the `nvPY installation guide <https://github.com/cpbotha/nvpy/blob/master/docs/installation.rst>`_.
        
        How to run for the first time
        =============================
        
        Create a file called .nvpy.cfg in your home directory that looks like
        the following::
        
            [nvpy]
            sn_username = your_simplenote_username
            sn_password = your_simplenote_password
        
        If you installed this via pip install, you should now be able to start
        the application by typing "nvpy". The first time you run it, it will take
        a while as it downloads all of your simplenote notes. Subsequent runs
        are much faster as it uses the database it stores in your home directory.
        
        If you prefer to run from your git clone, you can just invoke python on nvpy.py, or on the nvpy package directory.
        
        The `example nvpy.cfg <https://github.com/cpbotha/nvpy/blob/master/nvpy/nvpy-example.cfg>`_ shows how you can configure the font 
        family and size.
        
        Keyboard handling
        =================
        
        nvPY was designed for lightning-speed note-taking and management with the keyboard. Here's a summary of the different shortcut keys:
        
        ========== ==========
        Key combo  Action
        ========== ==========
        Ctrl-A     Select all text when in the note editor.
        Ctrl-D     Move note to trash. This can be easily recovered using the simplenote webapp.
        Ctrl-F     Start real-time incremental regular expression search. As you type, notes list is filtered. Up / down cursor keys go to previous / next note.
        Ctrl-G     Edit tags for currently selected note. Press ESC to return to note editing.
        Ctrl-M     Render Markdown note to HTML and open browser window.
        Ctrl-N     Create new note.
        Ctrl-Q     Exit nvPY.
        Ctrl-R     Render reStructuredText (reST) note to HTML and open browser window.
        Ctrl-S     Force sync of current note with simplenote server. Saving to disc and syncing to server also happen continuously in the background.
        Ctrl-Y     Redo note edits.
        Ctrl-Z     Undo note edits.
        ESC        Go from edit mode to notes list.
        ENTER      Start editing currently selected note. If there's a search string but no notes in the list, ENTER creates a new note with that search string as its title.
        ========== ==========
        
        Features
        ========
        
        * Syncs with simplenote.
        * Support for simplenote tags and note pinning.
        * Partial syncs (whilst notes are being edited) are done by a
          background thread so you can keep on working at light speed.
        * Can be used offline, also without simplenote account.
        * Search box does realtime regular expression searching in all your
          notes. All occurrences of that regular expression are also
          highlighted in currently active note.
        * Markdown rendering to browser.
        * Continuous rendering mode: If you activate this before
          starting the markdown rendering, nvpy will render new html of
          the currently open note every few seconds. Due to the refresh
          tag in the generated HTML, the browser will refresh every few
          seconds. MAGIC UPDATES!
        * reStructuredText (reST) rendering to browser. Yes, you can use nvPY
          as your reST previewer.
        * Automatic hyperlink highlighting in text widget.
        * KickAss(tm) inter-note linking with [[note name]]. If note name is
          not found in current list of notes, assumes it's a regular expression
          and sets it in the search bar. See the `screencast <http://youtu.be/NXuVMZr31SI>`_.
        
        Planned features
        ================
        
        * Full(ish) screen mode.
        * Full syncs also in background thread. At the moment does a full sync
          at startup, which can take a while. nvpy already does background thread
          saving and syncing while you work, so everything you type is backed up
          within a few seconds of you typing it.
        * Prettiness.
        
        Bugs and feedback
        =================
        
        * Report bugs with `the github issue tracker <https://github.com/cpbotha/nvpy/issues>`_.
        * It's an even better idea to clone, fix and then send me a pull request.
        * If you have questions, or would like to discuss nvpy-related matters, please do so via the `nvpy google discussion group / mailing list <https://groups.google.com/d/forum/nvpy>`_.
        * If you really like nvpy, you could make me and you even happier by `tipping me with paypal <https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BXXTJ9E97DG52>`_! 
        
        Credits
        =======
        
        * Sjaak Westdijk made significant contributions to the code starting after the 0.8.5 release.
        * nvpy uses the `fantastic simplenote.py library by mrtazz <https://github.com/mrtazz/simplenote.py>`_.
        * The brilliant application icon, a blue mini car (not as fast as the notational velocity rocket, get it?), is by `Cemagraphics <http://cemagraphics.deviantart.com/>`_.
        * stfa, thanks for the tip!
        
        
Keywords: simplenote note-taking tkinter nvalt markdown
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: X11 Applications
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: BSD License
