Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
2 contributors

Users who have contributed to this file

@cpbotha @yuuki0xff
95 lines (59 sloc) 3.22 KB

nvPY installation guide

There are many (mostly very easy) ways to install nvPY. This document summarises a number of them.

Windows step-by-step for beginners

Following this recipe, install the nvPY to your computer.

  1. Find the latest stable release from the releasege.

  2. Download nvpy-windows.zip file and extract it.

  3. Create a setting file. Start a notepad by pressing Windows-R and typing notepad %HOMEPATH%\nvpy.cfg. And write the following settings into the notepad.

    [nvpy]
    sn_username = your_simplenote_email
    sn_password = your_simplenote_password
    
  4. Start nvpy.exe.

  5. Wait a little for full synchronization to complete.

  6. Consider creating a shortcut to nvpy.exe on your desktop or in your start menu.

To upgrade an existing installation of nvpy, just replace the nvpy folder with the newer version.

Windows step-by-step for experts

  1. Download the Python 3.6 or later. Don't forget to install the Python launcher.

  2. Install nvPY from PyPI.

    py -3 -m pip install -U nvpy
    

    OR, download source code from repository, and install it.

    git clone https://github.com/cpbotha/nvpy
    cd nvpy
    py -3 -m pip install -U .
    
  3. Create a setting file to %HOMEPATH%\nvpy.cfg while referring to nvpy-example.cfg.

  4. Start nvPY by pressing Windows-R and typing nvpy.

To upgrade an existing installation of nvpy, do the following:

py -3 -m pip install -U nvpy

Ubuntu / Mint / Debian step-by-step

On Debian-flavoured systems with apt, this generally works:

sudo apt-get install python3 python3-tk python3-pip
sudo pip3 install -U nvpy

Create a file in your home directory called .nvpy.cfg with just the following contents:

[nvpy]
sn_username = your_simplenote_email
sn_password = your_simplenote_password

To start nvpy, just do:

nvpy

If the pip install does not upgrade to a newer version of nvpy, try:

sudo pip3 uninstall nvpy
sudo pip3 install --upgrade nvpy

Integrating with your Linux desktop environment

nvPY ships with a .desktop file, so that you can easily integrate it with your Linux desktop environment. This has been tested on Ubuntu Unity, but should work on KDE, Gnome3 and other environments as well.

First edit the file to check and optionally customize the Exec and Icon entries, then install it with:

xdg-desktop-menu install vxlabs-nvpy.desktop

Advanced users

You can install nvPY from a git repository.

git clone git://github.com/cpbotha/nvpy.git
cd nvpy
pip3 install -U -e '.[dev]'

Don't forget to create ~/.nvpy.cfg while referring to nvpy-example.cfg.

To start nvpy, just do:

nvpy
You can’t perform that action at this time.