kniteditor Installation Instructions

This document aims at showing all the ways that the knit editor can be installed.

Download

You can download the latest installers from the github releases. This includes these binaries:

All download locations are listed here:

Kivy Installation

Warning

Kivy as of today, 2016/07/04, works for Python 3.4. If you intend to use an other version, be aware that it might take a lot of time.

Windows

  1. If kivy does not work, uninstall kivy.
py -3.4 -m pip uninstall kivy
  1. Uninstall Python 3.4. Unless you want to install Visual Studio and configure how to compile Python modules with the right compiler at the right location, you uninstall Python 3.4. All the installed packages wil be left untouched. This is why we uninstalled kivy before.
  2. Use the kivy installer to install kivy. [Thanks]

Package installation from Pypi

The kniteditor library requires Python 3. It can be installed form the Python Package Index.

Windows

Install it with a specific python version under windows:

py -3 -m pip --no-cache-dir install --upgrade kniteditor

Test the installed version:

py -3 -m pytest --pyargs kniteditor

Linux

To install the version from the python package index, you can use your terminal and execute this under Linux:

sudo python3 -m pip --no-cache-dir install --upgrade kniteditor

test the installed version:

python3 -m pytest --pyargs kniteditor

Installation from Repository

You can setup the development version under Windows and Linux.

Linux

If you wish to get latest source version running, you can check out the repository and install it manually.

git clone https://github.com/fossasia/kniteditor.git
cd kniteditor
sudo python3 -m pip install --upgrade pip
sudo python3 -m pip install -r requirements.txt
sudo python3 -m pip install -r test-requirements.txt
py.test

To also make it importable for other libraries, you can link it into the site-packages folder this way:

sudo python3 setup.py link

Windows

Same as under Linux but you need to replace sudo python3 with py -3. This also counts for the following documentation.