diff options
| author | kali <kali@leap.se> | 2012-12-19 07:45:02 +0900 |
|---|---|---|
| committer | kali <kali@leap.se> | 2012-12-19 07:45:02 +0900 |
| commit | 5c0eb246d468454de9e84dca0d08c813459a5a6d (patch) | |
| tree | ce9dc227600aeaa7b2a11035926ed2ff15560efd /docs/dev/environment.rst | |
| parent | 20f779b644a551bf56cb735868c55cd50d7c3610 (diff) | |
documentation update!
reSTructured (no pun intended) the sphinx docs,
and trimmed README
Diffstat (limited to 'docs/dev/environment.rst')
| -rw-r--r-- | docs/dev/environment.rst | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/dev/environment.rst b/docs/dev/environment.rst new file mode 100644 index 00000000..7eafcdea --- /dev/null +++ b/docs/dev/environment.rst @@ -0,0 +1,59 @@ +.. _environment: + +Setting up a Work Environment +============================== + +This document covers how to get an enviroment ready to contribute code to the LEAP Client. + +Base Dependencies +------------------ +Leap client depends on these libraries: + +* `python 2.6 or 2.7` +* `qt4` libraries (see also :ref:`Troubleshooting PyQt install <pyqtvirtualenv>` about how to install inside your virtualenv) +* `libgnutls` +* `openvpn` + +.. _virtualenv: + +Working with virtualenv +----------------------- + +Intro to virtualenv +^^^^^^^^^^^^^^^^^^^ +Virtualenv blah blah + +Install python dependencies +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +You can install python dependencies with pip:: + + $ apt-get install python-pip python-dev libgnutls-dev + $ pip install -r pkg/requirements.pip + +.. _pyqtvirtualenv: + +Troubleshooting PyQt install inside a virtualenv +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you attempt to install PyQt inside a virtualenv using pip, it will fail because PyQt4 does not use the standard setup.py mechanism. + +As a workaround, you can run the following script after creating your virtualenv. It will symlink to your global PyQt installation (`this is the recommended way if you are running a debian-based system`):: + + $ pkg/postmkvenv.sh + +A second option if that does not work for you would be to install PyQt globally and pass the `--site-packages` option when you are creating your virtualenv:: + + $ apt-get install python-qt4 + $ virtualenv --site-packages . + +Or, if you prefer, you can also download the official PyQt tarball and execute `configure.py` in the root folder of their distribution, which generates a `Makefile`:: + + $ python configure.py + $ make && make install + + +Cloning the repo +---------------- + +`XXX` |