Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
135 lines (74 sloc) 3.09 KB

Installation

GNU/Linux

Shoebot runs on Python 2.7.

You need a few software packages on your system before installing Shoebot. There is a small handy script that will take care of this for you:

cd install
./install_dependencies.sh

Now, the simplest way to install Shoebot is system-wide, but you can also install it locally with a few extra steps. This has the advantage of keeping your base system intact.

If the script does not support your operating system, skip to Add support for another operating system.

System-wide install

Only one command necessary:

sudo python setup.py install

Local install using virtualenvwrapper

If you're using the handy virtualenvwrapper, these are the necessary commands:

mkvirtualenv shoebot
python setup.py install

To use Shoebot in the future, you will need to activate the environment first:

workon shoebot

Local install using a plain virtualenv

If you don't use virtualenvwrapper, run these commands after installing the dependencies.

virtualenv .env
source .env/bin/activate
python setup.py install

To use shoebot in the future, remember to activate the environment first.

source .env/bin/activate

Mac OS X

Installation on Mac OS X is identical to GNU/Linux based distributions.

Dependencies are installed via Homebrew <https://brew.sh/>_ through the install_dependencies.sh script.

Windows

Windows is currently untested. There used to be a purpose-built Windows version of Shoebot (Spryte) but it has been unmaintained for a long while.

If you try your hand at running Shoebot on Windows and can get anything running, let us know in our issue tracker so we can improve this documentation.

Add support for another operating system

To add support for another OS you will need to install the libraries that Shoebot depends on:

Core:

Python2 Pycairo Pygobject Pango

GUI:

Gtk3

The community for your operating system may be able to offer help here.

Check progress with diagnose

Shoebot provides a diagnose command as part of setup to check if things are working.

python setup.py diagnose

It's usually easiest to start with Python and Pycairo, then move on to Pango and Gtk3.

PGI with CairoCFFI and Gtk3

Shoebot can run under PGI and CairoCFFI, which may be easier to install than the recommened setup with pygobject and cairo.

In this setup Shoebot can work with the GUI, but text output is not available.

Open a bug on the Shoebot issue tracker

Open a bug on the issue tracker to track progress on adding your OS.

https://github.com/shoebot/shoebot/issues

You can’t perform that action at this time.