Setup on Mac

Paul de Vries edited this page Jun 4, 2016 · 32 revisions

OctoPrint for Mac


Note: These installation instructions are based on the steps I (@foosel) took in order to get OctoPrint up and running on a MacMini running OS X 10.9.5. I'm an absolute beginner when it comes to Macs (I'm at home on Linux and Windows), so please improve these instructions where necessary - this is a wiki anyone with a Github account can edit, so please, contribute!

The old instructions can still be found in the history of this page but were very much outdated by now.


Preparation

  • Must be performed with a user with Administrative privileges.

  • Requires the latest version of Xcode suitable for your OS X. For example, OS X 10.11 (El Capitan) requires Xcode 7. Specifically, this is to ensure that locally compiled components of Python libraries (such as pyobjc) can be installed successfully.

Install Xcode's Command Line Tools

  • xcode-select --install – this may ask you to accept the Xcode user license.
  • It doesn't hurt to also run sudo xcodebuild, to be sure the license acceptance process completed.

  • If you have more than one version of Xcode installed (unlikely -- you will know if you do) then ...

    sudo xcode-select -s /Applications/Xcode.app/Contents/Developer

Install Homebrew and use it to install Python

A version of Python is already installed within OS X. However, it's best to run with a more actively maintained, up to date and community supported version. OctoPrint employs Python 2.7, the default version installed by Homebrew, as follows:

  • ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  • brew install python

Install virtualenv

We utilize virtualenv to maintain an isolated Python environment for OctoPrint development. This prevents other, global Python libraries or updates from breaking OctoPrint. While not strictly required, virtualenv can save us from headaches, down the road. See the virtualdev docs for more detail.

  • pip install virtualenv

Installing OctoPrint

  • git clone https://github.com/foosel/OctoPrint.git
  • cd OctoPrint
  • virtualenv venv
  • source venv/bin/activate (assumes you're using the default BASH shell. active.csh is also available.)
  • pip install -U pyobjc
  • python setup.py install

Running OctoPrint

  • cd OctoPrint – the folder created from the above, git clone
  • source venv/bin/activate
  • octoprint

or

  • path/to/OctoPrint/venv/bin/octoprint

Updated 2016-06-05 by @gruvin. Corrections welcomed!