README.md

   1 Cura
   2 ====
   3
   4 If you are reading this, then you are looking at the *development* version of Cura. If you just want to use Cura look at the following location: https://github.com/daid/Cura/wiki
   5
   6 Development
   7 ===========
   8
   9 Cura is developed in Python. Getting Cura up and running for development is not very difficult. If you copy the python and pypy from a release into your Cura development checkout then you can use Cura right away, just like you would with a release.
  10 For development with git, check the help on github. Pull requests is the fastest way to get changes into Cura.
  11
  12
  13 Packaging
  14 ---------
  15
  16 Cura development comes with a script "package.sh", this script has been designed to run under unix like OSes (Linux, MacOS). Running it from sygwin is not a priority.
  17 The "package.sh" script generates a final release package. You should not need it during development, unless you are changing the release process. If you want to distribute your own version of Cura, then the package.sh script will allow you to do that.
  18
  19
  20 Mac OS X
  21 --------
  22 The following section describes how to prepare working environment for developing and packaing for Mac OS X.
  23 The working environment consist of build of Python, build of wxPython and all required Python packages.
  24
  25 We assume you already have Apple hardware with [64bit processor](http://support.apple.com/kb/HT3696) and you are familiar with tools like [virtualenv](http://pypi.python.org/pypi/virtualenv), [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) and [pip](http://www.pip-installer.org/en/latest/). Also ensure you have modern compiler installed.
  26
  27
  28 ###Install Python
  29 You'll need **non-system**, **framework-based**, **universal** with **deployment target set to 10.6** build of Python 2.7
  30
  31 **non-system**: Python is not bundeled with distribution of Mac OS X. Output of
  32 `python -c "import sys; print sys.prefix"`
  33 Output should *not* start with *"/System/Library/Frameworks/Python.framework/"*.
  34
  35 **framework-based**: Output of
  36 `python -c "import distutils.sysconfig as c; print(c.get_config_var('PYTHONFRAMEWORK'))"`
  37 should be non-empty string.
  38
  39 **universal**: Output of
  40 ``lipo -info `which python` ``
  41 should include both i386 and x86_64. E.g *"Architectures in the fat file: /usr/local/bin/python are: i386 x86_64"*.
  42
  43 **deployment target set to 10.6**: Output of
  44 ``otool -l `which python` ``
  45 should contain *"cmd LC_VERSION_MIN_MACOSX ... version 10.6"*.
  46
  47 The easiest way to install it is via [Homebrew](http://mxcl.github.com/homebrew/):
  48 `brew install --fresh https://github.com/downloads/GreatFruitOmsk/Cura/python.rb --universal`
  49 Note if you already have Python installed via Homebrew, you have to uninstall it first.
  50
  51
  52 ###Configure Virtualenv
  53 Create new virtualenv. If you have [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) installed:
  54 `mkvirtualenv Cura`
  55
  56 wxPython cannot be installed via pip, we have to build it from source by specifing prefix to our virtualenv.
  57
  58 Assuming you have virtualenv at *~/.virtualenvs/Cura/* and [wxPython sources](http://sourceforge.net/projects/wxpython/files/wxPython/2.9.4.0/wxPython-src-2.9.4.0.tar.bz2) at *~/Downloads/wxPython-src-2.9.4.0/*:
  59
  60 1. `cd` into *~/Downloads/wxPython-src-2.9.4.0/* and configure the sources:
  61
  62         ./configure --enable-universal_binary=i386,x86_64 \
  63         --prefix=$HOME/.virtualenvs/Cura/ \
  64         --enable-optimise \
  65         --with-libjpeg=builtin \
  66         --with-libpng=builtin \
  67         --with-libtiff=builtin \
  68         --with-zlib=builtin \
  69         --enable-monolithic \
  70         --with-macosx-version-min=10.6 \
  71         --disable-debug \
  72         --enable-unicode \
  73         --enable-std_string \
  74         --enable-display \
  75         --with-opengl \
  76         --with-osx_cocoa \
  77         --enable-dnd \
  78         --enable-clipboard \
  79         --enable-webkit \
  80         --enable-svg \
  81         --with-expat
  82
  83 2. `make install`
  84     Note to speedup the process I recommend you to enable multicore build by adding the -j*cores* flag:
  85     `make -j4 install`
  86 3. `cd` into *~/Downloads/wxPython-src-2.9.4.0/wxPython/*
  87 4. Build wxPython (Note `python` is the python of your virtualenv):
  88
  89         python setup.py build_ext \
  90         WXPORT=osx_cocoa \
  91         WX_CONFIG=$HOME/.virtualenvs/Cura/bin/wx-config \
  92         UNICODE=1 \
  93         INSTALL_MULTIVERSION=0 \
  94         BUILD_GLCANVAS=1 \
  95         BUILD_GIZMOS=1 \
  96         BUILD_STC=1
  97
  98 5. Install wxPython (Note `python` is the python of your virtualenv):
  99
 100         python setup.py install \
 101         --prefix=$HOME/.virtualenvs/Cura/ \
 102         WXPORT=osx_cocoa \
 103         WX_CONFIG=$HOME/.virtualenvs/Cura/bin/wx-config \
 104         UNICODE=1 \
 105         INSTALL_MULTIVERSION=0 \
 106         BUILD_GLCANVAS=1 \
 107         BUILD_GIZMOS=1 \
 108         BUILD_STC=1
 109
 110 6. Create file *~/.virtualenvs/Cura/bin/pythonw* with the following content:
 111
 112         #!/bin/bash
 113         ENV=`python -c "import sys; print sys.prefix"`
 114         PYTHON=`python -c "import sys; print sys.real_prefix"`/bin/python
 115         export PYTHONHOME=$ENV
 116         exec $PYTHON "$@"
 117
 118 At this point virtualenv is configured for wxPython development.
 119 Remember to use `python` for pacakging and `pythonw` to run app for debugging.
 120
 121
 122 ###Install Python Packages
 123 Required python packages are specified in *requirements.txt* and *requirements_darwin.txt*
 124 If you use virtualenv, installing requirements as easy as `pip install -r requirements_darwin.txt`
 125
 126 At time of writing PyObjC 2.5 is not available via pip, so you have to install it manually (Note `python` is the python of your virtualenv):
 127
 128 1. Download [PyObjC 2.5](https://bitbucket.org/ronaldoussoren/pyobjc/get/pyobjc-2.5.zip)
 129 2. Extract the archive and `cd` into the directory
 130 3. `python install.py`
 131     If build fails, try to use clang: `CC=/usr/bin/clang python install.py`
 132
 133
 134 ###Package Cure into application
 135 Ensure that `package.sh` build target (see the very top of the file) is:
 136
 137     #BUILD_TARGET=${1:-all}
 138     #BUILD_TARGET=win32
 139     #BUILD_TARGET=linux
 140     BUILD_TARGET=darwin
 141
 142 Also ensure that virtualenv is activated, so `python` points to the python of your virtualenv (e.g. ~/.virtualenvs/Cura/bin/python).
 143
 144
 145 ###Tests
 146 Cura was built (and each build was tested) on the following platforms:
 147
 148 - 10.6.8
 149 - 10.7.3
 150 - 10.8.2
 151 - 10.8.3 (Jan 8 Seed)
 152
 153 With following tools, libs and python pacakges:
 154
 155 - Python 2.7.3 (installed via [Homebrew](http://mxcl.github.com/homebrew/) by using custom [formula](https://github.com/downloads/GreatFruitOmsk/Cura/python.rb) with *--universal* option)
 156 - [wxPython 2.9.4.0](http://sourceforge.net/projects/wxpython/files/wxPython/2.9.4.0/wxPython-src-2.9.4.0.tar.bz2)
 157 - virtualenvwrapper 3.6
 158 - vritualenv 1.8.4
 159 - llvm-gcc 4.2 (/usr/bin/cc == /usr/bin/llvm-gcc-4.2)
 160 - clang 2.1, 3.0 (PyObjC 2.5 failed to build with llvm-gcc)
 161 - [PyObjC 2.5](https://bitbucket.org/ronaldoussoren/pyobjc/get/pyobjc-2.5.zip)
 162 - PyOpenGL 3.0.2
 163 - altgraph 0.10.1
 164 - macholib 1.5
 165 - modulegraph 0.10.2
 166 - numpy 1.6.2
 167 - py2app 0.7.2
 168 - pyserial 2.6
 169 - wsgiref 0.1.2