From 36b0dfacca794e9cb899b5dde2dae3b8bbc6cc43 Mon Sep 17 00:00:00 2001 From: kali Date: Tue, 7 Aug 2012 04:14:06 +0900 Subject: build default provider openvpn config. preparation for completion of #356, #355, #354, #182 if no default openvpn config is present, we build one with a preset template and the remote_ip of the eip service as the only input. right now we're taking it from the eip.cfg file. --- README.txt | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index 14ac253f..4a4ae52f 100644 --- a/README.txt +++ b/README.txt @@ -1,15 +1,34 @@ ======================================== = LEAP = -= The Internet Encryption Toolkit = += The LEAP Encryption Access Project = += your internet encryption toolkit = ======================================== Install ======= python setup.py install +Running +======= + +You need to set up a provider in your eip.cfg file: + +cd ~/.config/leap +vim eip.cfg + +[provider] +remote_ip = XXX.XXX.XXX.XXX + +and then run: + +leap --debug + +(or python app.py --debug if you run it from the src/leap folder). + Running tests ============= nosetests -v +[ currently broken ] Deps ==== -- cgit v1.2.3 From 51314f678cedce043021bf36469fd4fb062e2443 Mon Sep 17 00:00:00 2001 From: kali Date: Wed, 8 Aug 2012 19:42:07 +0900 Subject: updated README with brief running tests note --- README.txt | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index 4a4ae52f..bb6f0826 100644 --- a/README.txt +++ b/README.txt @@ -27,13 +27,27 @@ leap --debug Running tests ============= -nosetests -v -[ currently broken ] + +./run_tests.sh + +if you want to run specific tests, pass the (sub)module to nose: + +nosetests leap.util + +or + +nosetests leap.util.test_leap_argparse Deps ==== + apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools +Test-deps +========= + +test-requires + Hack ==== -- cgit v1.2.3 From bda0f214d13387e4efceb127f0a8bbb37935f98c Mon Sep 17 00:00:00 2001 From: k clair Date: Tue, 7 Aug 2012 11:19:32 -0700 Subject: updated README cherry-picked kclair updates on buildbot branch into develop branch. --- README.txt | 51 ++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 38 insertions(+), 13 deletions(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index bb6f0826..510bda58 100644 --- a/README.txt +++ b/README.txt @@ -4,12 +4,34 @@ = your internet encryption toolkit = ======================================== +Installation +============= + +Dependencies +-------------- + +* python <= 2.7 +* python setuptools +* qt4 libraries +* python-qt4 +* python-nose, python-mock, python-coverage (if you want to run tests) + +If you are on a debian-based system, you can run: + +apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools python-setuptools python-nose + Install -======= +--------------- + +If not using virtualenv: +sudo python setup.py install + +If using virtualenv: python setup.py install -Running -======= + +Running the App +----------------- You need to set up a provider in your eip.cfg file: @@ -25,8 +47,11 @@ leap --debug (or python app.py --debug if you run it from the src/leap folder). +Development +============== + Running tests -============= +------------- ./run_tests.sh @@ -38,18 +63,14 @@ or nosetests leap.util.test_leap_argparse -Deps -==== - -apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools Test-deps -========= +--------- -test-requires +have a look at setup/test-requires Hack -==== +-------------- (recommended) virtualenv . # ensure your .gitignore knows about it @@ -58,10 +79,14 @@ bin/activate # you should probably simlink sip.so and PyQt4 to your system-wide # install, there are some issues with it. -python setup.py develop # ... TBD: finish develop howto. +python setup.py develop + +# ... TBD: finish develop howto. +# ... and explain how is python setup develop useful. Compiling resource/ui files -=========================== +----------------------------- + You should refresh resource/ui files every time you change an image or a resource/ui (.ui / .qc). From the root folder: -- cgit v1.2.3 From b0ef9f98d8384cb68e59fac91142e5ac9f2ab47c Mon Sep 17 00:00:00 2001 From: k clair Date: Thu, 9 Aug 2012 13:06:28 -0700 Subject: update README with another example for how to run tests (mostly i'm just making a commit to see if buildbot catches it and starts a build) --- README.txt | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.txt') diff --git a/README.txt b/README.txt index 510bda58..a7c03f80 100644 --- a/README.txt +++ b/README.txt @@ -55,6 +55,9 @@ Running tests ./run_tests.sh +force no virtualenv and create coverage reports: +./run_tests.sh -N -c + if you want to run specific tests, pass the (sub)module to nose: nosetests leap.util -- cgit v1.2.3 From 5006fda226a3fa6afda231df8aa733477bd4e420 Mon Sep 17 00:00:00 2001 From: kali Date: Fri, 7 Sep 2012 05:20:41 +0900 Subject: update README with tox info and PyQt annoyances --- README.txt | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index a7c03f80..28971255 100644 --- a/README.txt +++ b/README.txt @@ -23,27 +23,31 @@ apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools python-setuptools pyth Install --------------- -If not using virtualenv: +Global install: sudo python setup.py install If using virtualenv: python setup.py install +Install PyQt +------------ +pip install PyQt will fail because PyQt4 does not use the standard setup.py mechanism. +Instead, they use configure.py which generates a Makefile. -Running the App ------------------ +python configure.py +make && make install -You need to set up a provider in your eip.cfg file: +You can: -cd ~/.config/leap -vim eip.cfg +* install PyQt globally and make a virtualenv with --site-packages +* run pkg/install_pyqt.sh inside your virtualenv (with --no-site-packages) +* run pkg/postmkvenv.sh after creating your virtualenv, for making symlinks to your global PyQt installation. -[provider] -remote_ip = XXX.XXX.XXX.XXX -and then run: +Running the App +----------------- -leap --debug +leap --debug --logfile /tmp/leap.log (or python app.py --debug if you run it from the src/leap folder). @@ -66,6 +70,11 @@ or nosetests leap.util.test_leap_argparse +Tox +--- +For running testsuite against all the supported python versions (currently 2.6 and 2.7), run: + +tox -v Test-deps --------- @@ -78,14 +87,9 @@ Hack (recommended) virtualenv . # ensure your .gitignore knows about it bin/activate - -# you should probably simlink sip.so and PyQt4 to your system-wide -# install, there are some issues with it. - +pkg/postmkvenv.sh python setup.py develop -# ... TBD: finish develop howto. -# ... and explain how is python setup develop useful. Compiling resource/ui files ----------------------------- -- cgit v1.2.3 From 65b953117765a88ec6fb6ba9f3b36bc1434133a4 Mon Sep 17 00:00:00 2001 From: kali Date: Wed, 12 Sep 2012 10:02:38 +0900 Subject: added gnutls dep to README --- README.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index 28971255..c298ef91 100644 --- a/README.txt +++ b/README.txt @@ -14,11 +14,12 @@ Dependencies * python setuptools * qt4 libraries * python-qt4 +* python-gnutls * python-nose, python-mock, python-coverage (if you want to run tests) If you are on a debian-based system, you can run: -apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools python-setuptools python-nose +apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools python-gnutls python-setuptools python-nose Install --------------- -- cgit v1.2.3 From 430b6326d06d81c44d534543c8e9684a5c0fcb15 Mon Sep 17 00:00:00 2001 From: kali Date: Fri, 14 Sep 2012 04:18:43 +0900 Subject: force 1.1.9 version of python-gnutls --- README.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index c298ef91..a392f2cb 100644 --- a/README.txt +++ b/README.txt @@ -87,7 +87,8 @@ Hack (recommended) virtualenv . # ensure your .gitignore knows about it -bin/activate +source bin/activate +git checkout develop pkg/postmkvenv.sh python setup.py develop -- cgit v1.2.3 From cfb7f5a2e9bae74dd60067a399a222d62e81da2c Mon Sep 17 00:00:00 2001 From: antialias Date: Fri, 14 Sep 2012 12:04:22 -0400 Subject: libgnutls-dev was missing from README installation instructions. --- README.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index a392f2cb..1a786500 100644 --- a/README.txt +++ b/README.txt @@ -19,7 +19,7 @@ Dependencies If you are on a debian-based system, you can run: -apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools python-gnutls python-setuptools python-nose +apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools python-gnutls libgnutls-dev python-setuptools python-nose Install --------------- -- cgit v1.2.3 From 9706790006ec80eb358088288e1e770a465b3b01 Mon Sep 17 00:00:00 2001 From: kali Date: Tue, 25 Sep 2012 04:53:46 +0900 Subject: add branding step to hack section in readme --- README.txt | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index 1a786500..953ca5f8 100644 --- a/README.txt +++ b/README.txt @@ -55,6 +55,18 @@ leap --debug --logfile /tmp/leap.log Development ============== +Hack +-------------- + +(recommended) +virtualenv . # ensure your .gitignore knows about it +source bin/activate +git checkout develop +pkg/postmkvenv.sh + +python setup.py branding +python setup.py develop + Running tests ------------- @@ -82,16 +94,6 @@ Test-deps have a look at setup/test-requires -Hack --------------- - -(recommended) -virtualenv . # ensure your .gitignore knows about it -source bin/activate -git checkout develop -pkg/postmkvenv.sh -python setup.py develop - Compiling resource/ui files ----------------------------- -- cgit v1.2.3 From a5366ebc06a1345f9248672e91cf87379d3bcec1 Mon Sep 17 00:00:00 2001 From: kali Date: Tue, 25 Sep 2012 06:04:58 +0900 Subject: add script name change when branded build --- README.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index 953ca5f8..ba858454 100644 --- a/README.txt +++ b/README.txt @@ -48,7 +48,12 @@ You can: Running the App ----------------- -leap --debug --logfile /tmp/leap.log +leap-client --debug --logfile /tmp/leap.log + +If you're running a branded build, the script name will have a suffix that +depends on your build flavor: + +leap-client-springbok (or python app.py --debug if you run it from the src/leap folder). -- cgit v1.2.3 From bee0813fd3d99be1bf85f55fd63bc0c603d0104e Mon Sep 17 00:00:00 2001 From: k clair Date: Wed, 26 Sep 2012 00:17:54 -0700 Subject: clarifying version requirement for the gnutls module in the README. --- README.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.txt') diff --git a/README.txt b/README.txt index ba858454..238cd1e3 100644 --- a/README.txt +++ b/README.txt @@ -14,7 +14,7 @@ Dependencies * python setuptools * qt4 libraries * python-qt4 -* python-gnutls +* python-gnutls == 1.1.9 * python-nose, python-mock, python-coverage (if you want to run tests) If you are on a debian-based system, you can run: -- cgit v1.2.3 From 7a58425cbb090acb3777b602bd3350581f7b30e8 Mon Sep 17 00:00:00 2001 From: kali Date: Wed, 3 Oct 2012 21:23:38 +0900 Subject: updated readme with some clarifications hopefully it's a bit more clear now. developer: feedback welcome. are you able to get it running with the instructions listed here? --- README.txt | 111 ------------------------------------------------------------- 1 file changed, 111 deletions(-) delete mode 100644 README.txt (limited to 'README.txt') diff --git a/README.txt b/README.txt deleted file mode 100644 index 238cd1e3..00000000 --- a/README.txt +++ /dev/null @@ -1,111 +0,0 @@ -======================================== -= LEAP = -= The LEAP Encryption Access Project = -= your internet encryption toolkit = -======================================== - -Installation -============= - -Dependencies --------------- - -* python <= 2.7 -* python setuptools -* qt4 libraries -* python-qt4 -* python-gnutls == 1.1.9 -* python-nose, python-mock, python-coverage (if you want to run tests) - -If you are on a debian-based system, you can run: - -apt-get install python-qt4 python-qt4-doc pyqt4-dev-tools python-gnutls libgnutls-dev python-setuptools python-nose - -Install ---------------- - -Global install: -sudo python setup.py install - -If using virtualenv: -python setup.py install - -Install PyQt ------------- -pip install PyQt will fail because PyQt4 does not use the standard setup.py mechanism. -Instead, they use configure.py which generates a Makefile. - -python configure.py -make && make install - -You can: - -* install PyQt globally and make a virtualenv with --site-packages -* run pkg/install_pyqt.sh inside your virtualenv (with --no-site-packages) -* run pkg/postmkvenv.sh after creating your virtualenv, for making symlinks to your global PyQt installation. - - -Running the App ------------------ - -leap-client --debug --logfile /tmp/leap.log - -If you're running a branded build, the script name will have a suffix that -depends on your build flavor: - -leap-client-springbok - -(or python app.py --debug if you run it from the src/leap folder). - -Development -============== - -Hack --------------- - -(recommended) -virtualenv . # ensure your .gitignore knows about it -source bin/activate -git checkout develop -pkg/postmkvenv.sh - -python setup.py branding -python setup.py develop - -Running tests -------------- - -./run_tests.sh - -force no virtualenv and create coverage reports: -./run_tests.sh -N -c - -if you want to run specific tests, pass the (sub)module to nose: - -nosetests leap.util - -or - -nosetests leap.util.test_leap_argparse - -Tox ---- -For running testsuite against all the supported python versions (currently 2.6 and 2.7), run: - -tox -v - -Test-deps ---------- - -have a look at setup/test-requires - - -Compiling resource/ui files ------------------------------ - -You should refresh resource/ui files every time you -change an image or a resource/ui (.ui / .qc). From -the root folder: - -make ui -make resources -- cgit v1.2.3