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