d7eaaf319521b59dbf28a5a0d3d16b5e9cc3bfb7
[bitmask_bundler.git] / README.rst
1 Bundler
2 +++++++
3
4 This application is intended to create bundles for the platform in which its being run. This should eventually become the main tool in order to create reproducible builds.
5
6 How to use
7 ++++++++++
8
9 NOTE: Most of this will be done automatically in a while, but this is how it's done now.
10
11 - Install Xcode and command line tools (OSX only)
12 - Create a new virtualenv
13
14 ::
15   mkvirtualenv bundle
16
17 - Install bundler deps
18
19 ::
20   pip install -r pkg/requirements.pip
21
22 - psutils is a dependency for another dependency, it might get installed in a zip form, which we don't want, so we install it by hand for now
23
24 ::
25   pip install psutil
26
27 - We need a slightly different python-gnupg, so clone from a different repo
28
29 ::
30   git clone https://github.com/chiiph/python-gnupg
31   cd python-gnupg/
32   git checkout develop
33   git pull origin develop
34   python setup.py develop
35
36 - Same thing with protobuf.socketrpc
37
38 ::
39   git clone https://github.com/chiiph/protobuf-socket-rpc
40   cd protobuf-socket-rpc
41   python setup.py easy_install -Z .
42
43 - Install Qt 4.8 in whatever way you prefer.
44
45 - Build PySide:
46
47 ::
48   git clone git://gitorious.org/pyside/apiextractor.git
49   git clone git://gitorious.org/pyside/generatorrunner.git
50   git clone git://gitorious.org/pyside/shiboken.git
51   git clone git://gitorious.org/pyside/pyside.git
52   git clone git://gitorious.org/pyside/pyside-tools.git
53   export PYSIDESANDBOXPATH=$HOME/Code/pyside/sandbox
54   export PATH=$PYSIDESANDBOXPATH/bin:$PATH
55   export PYTHONPATH=$PYSIDESANDBOXPATH/lib/python2.6/site-packages:$PYTHONPATH
56   export DYLD_LIBRARY_PATH=$PYSIDESANDBOXPATH/lib:$DYLD_LIBRARY_PATH
57   export PKG_CONFIG_PATH=$PYSIDESANDBOXPATH/lib/pkgconfig:$PKG_CONFIG_PATH
58
59   # In OSX, the paths may vary depending on the Qt installation
60   runcmake -DCMAKE_OSX_DEPLOYMENT_TARGET=10.7 -DCMAKE_OSX_SYSROOT=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.8.sdk .. -DQT_QMAKE_EXECUTABLE=/usr/local/bin/qmake -DQT_INCLUDE_DIR=/usr/local/include/ -DQT_INCLUDES=/usr/local/include/ -DALTERNATIVE_QT_INCLUDE_DIR=/usr/local/include/
61   # In Linux
62   runcmake ..
63
64   make install
65
66   # Make them available from the virtualenv
67   ln -s $PYSIDESANDBOXPATH/lib/python2.7/site-packages/PySide $VIRTUAL_ENV/lib/python2.7/site-packages/PySide
68   ln -s $PYSIDESANDBOXPATH/lib/python2.7/site-packages/pysideuic $VIRTUAL_ENV/lib/python2.7/site-packages/pysideuic
69
70 - Create a paths file: The problem is that inside a virtualenv we don't have access to the real distutils, so we'll need to look for it on the "original" (i.e. non-virtualenv) paths for python.
71
72 ::
73   python bundler/create_paths.py <paths file>
74
75 - Collect the binaries. We aren't building everything yet, so you'll need to collect the following files:
76
77 ::
78   # OSX
79   Bitmask <-- this is the bitmask_launcher
80   Python
81   QtCore
82   QtGui
83   cocoasudo
84   gpg
85   libboost_filesystem.dylib
86   libboost_python.dylib
87   libboost_system.dylib
88   libpng15.15.dylib
89   libpyside-python2.7.1.2.dylib
90   libshiboken-python2.7.1.2.dylib
91   openvpn.files
92   openvpn.leap
93   qt_menu.nib
94   tuntap-installer.app
95
96 - (Optional) Seed a configuration: You might want to create a bundle with a specific configuration pinned providers.
97
98 - Create the bundle:
99
100 ::
101   python bundler/main.py --workon <path/to/bundle/temp> --paths-file <paths file> --binaries <binaries dir> --seeded-config <seeded config> [--nightly] --do gitclone pythonsetup
102   python bundler/main.py --workon <path/to/bundle/temp> --paths-file <paths file> --binaries <binaries dir> --seeded-config <seeded config> [--nightly] --skip gitclone pythonsetup