Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

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 releases page.

  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, current releases of nypy require Python 3.6 or later. If you are running Debian-buster, Ubuntu-bionic, or later, which have a compatible release of Python as the default for python3, this generally works:

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

Older releases may require manual installation of python 3.6 or later.

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

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

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

Alternative method

Some operating systems will present you with the dependency problems when you install programs using pip without creating a virtual environment.

One solution is to use virtualenvwrapper.

Another way to install it could be with Conda or Miniconda, some distibutions provide conda in their repositories.

This example shows you how to install Conda on Fedora, standard Bash setup - change it if you use other shell. If your distribution provides the conda package, use your package manager (zypper, pacman etc), otherwise follow the official Conda documentation:

sudo dnf install conda
conda init bash
conda install pip
conda create -n nvpy
conda activate nvpy
pip install nvpy

The resulting installation will end up in ~/.conda/envs/nvpy/bin. Now symlink it or create an alias for easier access to nvpy binary.

For example NixOS distribution also provides `Conda < https://nixos.org/nixos/packages.html?query=conda>`_, to install:

nix-env -iA nixos.conda

Then follow the setup above.

Contributors and expert 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

To browse nvPY internal docs, just do:

pip3 install -U pdoc3
pdoc --http localhost:8080 nvpy
# Open http://localhost:8080, you can see docs.