Skip to content

Latest commit

 

History

History
73 lines (37 loc) · 2.05 KB

Installation.md

File metadata and controls

73 lines (37 loc) · 2.05 KB

Prebuilt Applications

The easiest way to get up and running with Mentalist is to use the prebuilt applications, which are available for Linux, OS X and Windows on the Mentalist releases page.

Install from Source

Prerequisites

Linux (APT package manager)

Check if Python 3 is installed by running python3 --version. If it is not, run:

sudo apt-get update && apt-get install python3.6

Additionally, you will need setuptools and Tk:

sudo apt-get install python3-setuptools python3-tk

OS X

There are varying ways of installing Python 3 on OS X, but the easiest is to install through Homebrew.

brew update && brew install python3

Windows

If using Windows, please refer to Installing Python 3 on Windows from the Hitchhiker's Guide. It is also extremely helpful to click the Python 3 installer checkbox to add Python to your PATH.

Install Mentalist

Clone the Mentalist repository:

git clone https://github.com/sc0tfree/mentalist.git

Go into the directory:

cd mentalist

Run setup.py:

python3 setup.py install

Running Mentalist

You can now run mentalist from the shell with the command mentalist.

Rebuilding Applications

It is possible to rebuild the applications from source using PyInstaller. First, install PyInstaller:

pip3 install pyinstaller

To build the application for your current operating system, execute:

pyinstaller --onefile --windowed mentalist.spec

Note: Make sure that pyinstaller in your path refers to the Python 3 version and not Python 2!

Once completed, you can find the executable in the dist directory.

OS X building:

You must have the Homebrew version of Python 3 to compile an OS X application. The python.org version will fail for building.

Linux building:

Make sure to install pip3 and Tk with:

sudo apt-get install python3-tk python3-pip

Running Tests

To run tests, use python3 setup.py test