From 5ff29dc57e2877a14e705d09b7042cddf4165d0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Touceda?= Date: Wed, 6 Mar 2013 15:27:23 -0300 Subject: Remove everything to start from scratch --- README.rst | 120 ------------------------------------------------------------- 1 file changed, 120 deletions(-) delete mode 100644 README.rst (limited to 'README.rst') diff --git a/README.rst b/README.rst deleted file mode 100644 index 9ef3f99b..00000000 --- a/README.rst +++ /dev/null @@ -1,120 +0,0 @@ -========================================= -The LEAP Encryption Access Project Client -========================================= - -*your internet encryption toolkit* - -Read the docs! -============== - -You can read the documentation online at `http://leap-client.readthedocs.org `_. If you prefer to build it locally, run:: - - $ cd docs - $ make html - -Quick Start -============== - -At the current development stage we still do not have any versioned release. Instead, you might want to have a look at the `testers guide `_ for a quick howto on fetching and testing latest development code. - -Dependencies ------------------- - -LEAP Client depends on these libraries: - -* ``python 2.6`` or ``2.7`` -* ``qt4 libraries`` -* ``libgnutls`` -* ``openvpn`` - -Python packages are listed in ``pkg/requirements.pip`` and ``pkg/test-requirements.pip`` - -Debian -^^^^^^ - -Under a debian-based system, you can run:: - - $ apt-get install openvpn python-qt4 python-crypto python-requests python-gnutls - -For *testing*:: - - $ apt-get install python-nose python-mock python-coverage - -For *building* the package you will need to install also:: - - $ apt-get install pyqt4-dev-tools libgnutls-dev python-setuptools python-all-dev - - -pip -^^^ - -Use pip to install the required python packages:: - - $ apt-get install python-pip python-dev libgnutls-dev - $ pip install -r pkg/requirements.pip - - -Installing ------------ - -After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:: - - $ python setup.py install - - -Running -------- - -After a successful installation, there should be a launcher called ``leap-client`` somewhere in your path:: - - $ leap-client - - -Hacking -======= - -See the `hackers guide `_. - -The LEAP client git repository is available at:: - - git://leap.se/leap_client - -Some steps need to be run when setting a development environment for the first time. - -Enable a **virtualenv** to isolate your libraries. (Current *.gitignore* knows about a virtualenv in the root tree. If you do not like that place, just change ``.`` for **):: - - $ virtualenv . - $ source bin/activate - -Make sure you are in the development branch:: - - (leap_client)$ git checkout develop - -Symlink your global pyqt libraries:: - - (leap_client)$ pkg/postmkvenv.sh - -And make your working tree available to your pythonpath:: - - (leap_client)$ python setup.py develop - - -Testing -======= - -Have a look at ``pkg/test-requirements.pip`` for the tests dependencies. - -To run the test suite:: - - $ ./run_tests.sh - -which the first time should automagically install all the needed dependencies in your virtualenv for you. - -License -======= - -.. image:: https://raw.github.com/leapcode/leap_client/develop/docs/user/gpl.png - -The LEAP Client is released under the terms of the `GNU GPL version 3`_ or later. - -.. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt -- cgit v1.2.3 From 6d6600a495ef48e0f04cb78bedca8fb913bada2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1s=20Touceda?= Date: Wed, 6 Mar 2013 16:10:30 -0300 Subject: Add README and NEWS --- README.rst | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 README.rst (limited to 'README.rst') diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..9ef3f99b --- /dev/null +++ b/README.rst @@ -0,0 +1,120 @@ +========================================= +The LEAP Encryption Access Project Client +========================================= + +*your internet encryption toolkit* + +Read the docs! +============== + +You can read the documentation online at `http://leap-client.readthedocs.org `_. If you prefer to build it locally, run:: + + $ cd docs + $ make html + +Quick Start +============== + +At the current development stage we still do not have any versioned release. Instead, you might want to have a look at the `testers guide `_ for a quick howto on fetching and testing latest development code. + +Dependencies +------------------ + +LEAP Client depends on these libraries: + +* ``python 2.6`` or ``2.7`` +* ``qt4 libraries`` +* ``libgnutls`` +* ``openvpn`` + +Python packages are listed in ``pkg/requirements.pip`` and ``pkg/test-requirements.pip`` + +Debian +^^^^^^ + +Under a debian-based system, you can run:: + + $ apt-get install openvpn python-qt4 python-crypto python-requests python-gnutls + +For *testing*:: + + $ apt-get install python-nose python-mock python-coverage + +For *building* the package you will need to install also:: + + $ apt-get install pyqt4-dev-tools libgnutls-dev python-setuptools python-all-dev + + +pip +^^^ + +Use pip to install the required python packages:: + + $ apt-get install python-pip python-dev libgnutls-dev + $ pip install -r pkg/requirements.pip + + +Installing +----------- + +After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:: + + $ python setup.py install + + +Running +------- + +After a successful installation, there should be a launcher called ``leap-client`` somewhere in your path:: + + $ leap-client + + +Hacking +======= + +See the `hackers guide `_. + +The LEAP client git repository is available at:: + + git://leap.se/leap_client + +Some steps need to be run when setting a development environment for the first time. + +Enable a **virtualenv** to isolate your libraries. (Current *.gitignore* knows about a virtualenv in the root tree. If you do not like that place, just change ``.`` for **):: + + $ virtualenv . + $ source bin/activate + +Make sure you are in the development branch:: + + (leap_client)$ git checkout develop + +Symlink your global pyqt libraries:: + + (leap_client)$ pkg/postmkvenv.sh + +And make your working tree available to your pythonpath:: + + (leap_client)$ python setup.py develop + + +Testing +======= + +Have a look at ``pkg/test-requirements.pip`` for the tests dependencies. + +To run the test suite:: + + $ ./run_tests.sh + +which the first time should automagically install all the needed dependencies in your virtualenv for you. + +License +======= + +.. image:: https://raw.github.com/leapcode/leap_client/develop/docs/user/gpl.png + +The LEAP Client is released under the terms of the `GNU GPL version 3`_ or later. + +.. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt -- cgit v1.2.3 From 2c9009e8b46ae07679d55916473f74f40d609e99 Mon Sep 17 00:00:00 2001 From: Tomas Touceda Date: Tue, 16 Apr 2013 09:47:05 -0300 Subject: Update README --- README.rst | 53 ++++++++++++++++++++--------------------------------- 1 file changed, 20 insertions(+), 33 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 9ef3f99b..919dcc36 100644 --- a/README.rst +++ b/README.rst @@ -4,19 +4,6 @@ The LEAP Encryption Access Project Client *your internet encryption toolkit* -Read the docs! -============== - -You can read the documentation online at `http://leap-client.readthedocs.org `_. If you prefer to build it locally, run:: - - $ cd docs - $ make html - -Quick Start -============== - -At the current development stage we still do not have any versioned release. Instead, you might want to have a look at the `testers guide `_ for a quick howto on fetching and testing latest development code. - Dependencies ------------------ @@ -24,7 +11,7 @@ LEAP Client depends on these libraries: * ``python 2.6`` or ``2.7`` * ``qt4 libraries`` -* ``libgnutls`` +* ``libopenssl`` * ``openvpn`` Python packages are listed in ``pkg/requirements.pip`` and ``pkg/test-requirements.pip`` @@ -32,34 +19,31 @@ Python packages are listed in ``pkg/requirements.pip`` and ``pkg/test-requiremen Debian ^^^^^^ -Under a debian-based system, you can run:: - - $ apt-get install openvpn python-qt4 python-crypto python-requests python-gnutls - -For *testing*:: - - $ apt-get install python-nose python-mock python-coverage - -For *building* the package you will need to install also:: - - $ apt-get install pyqt4-dev-tools libgnutls-dev python-setuptools python-all-dev +With a Debian based system, to be able to run leap-client you need to run the following command:: + $ sudo apt-get install openvpn python-pyside pyside-tools python-setuptools python-crypto python-requests python-openssl python-all-dev pip ^^^ Use pip to install the required python packages:: - $ apt-get install python-pip python-dev libgnutls-dev + $ sudo apt-get install python-pip python-dev python-openssl $ pip install -r pkg/requirements.pip Installing ----------- +For the leap-client to run, you need to install the leap.common package first, if you used pip, you can skip this step:: + + $ git clone git://leap.se/leap_pycommon.git + $ cd leap_pycommon + $ sudo python setup.py install + After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:: - $ python setup.py install + $ sudo python setup.py install Running @@ -69,15 +53,18 @@ After a successful installation, there should be a launcher called ``leap-client $ leap-client +If you are testing a new provider and do not have a CA certificate chain tied to your SSL certificate, you should execute leap-client in the following way:: + + $ leap-client --danger + +Beware this is only for testing, its usage is *highly* discouraged. Hacking ======= -See the `hackers guide `_. - The LEAP client git repository is available at:: - git://leap.se/leap_client + git://leap.se/leap_client Some steps need to be run when setting a development environment for the first time. @@ -96,10 +83,10 @@ Symlink your global pyqt libraries:: And make your working tree available to your pythonpath:: - (leap_client)$ python setup.py develop + (leap_client)$ python setup.py develop -Testing +Testing ======= Have a look at ``pkg/test-requirements.pip`` for the tests dependencies. @@ -107,7 +94,7 @@ Have a look at ``pkg/test-requirements.pip`` for the tests dependencies. To run the test suite:: $ ./run_tests.sh - + which the first time should automagically install all the needed dependencies in your virtualenv for you. License -- cgit v1.2.3 From 1922874c6c4c0f05eeb3ce6b673a5469f875df0a Mon Sep 17 00:00:00 2001 From: Tomas Touceda Date: Tue, 16 Apr 2013 10:21:05 -0300 Subject: Install leap.common from pip --- README.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 919dcc36..7a47ce70 100644 --- a/README.rst +++ b/README.rst @@ -37,9 +37,7 @@ Installing For the leap-client to run, you need to install the leap.common package first, if you used pip, you can skip this step:: - $ git clone git://leap.se/leap_pycommon.git - $ cd leap_pycommon - $ sudo python setup.py install + $ sudo pip install leap.common After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:: -- cgit v1.2.3 From 2a402c32fa6f709e69ff7a5ae09266cf605839a2 Mon Sep 17 00:00:00 2001 From: Tomas Touceda Date: Tue, 16 Apr 2013 10:41:53 -0300 Subject: Remove debian installation for dependencies, just use setup.py Also, note to run make before installing leap-client --- README.rst | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 7a47ce70..806e222c 100644 --- a/README.rst +++ b/README.rst @@ -21,28 +21,17 @@ Debian With a Debian based system, to be able to run leap-client you need to run the following command:: - $ sudo apt-get install openvpn python-pyside pyside-tools python-setuptools python-crypto python-requests python-openssl python-all-dev - -pip -^^^ - -Use pip to install the required python packages:: - - $ sudo apt-get install python-pip python-dev python-openssl - $ pip install -r pkg/requirements.pip - + $ sudo apt-get install openvpn python-pyside pyside-tools python-setuptools python-all-dev python-pip python-dev python-openssl Installing ----------- -For the leap-client to run, you need to install the leap.common package first, if you used pip, you can skip this step:: - - $ sudo pip install leap.common - After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:: - $ sudo python setup.py install + $ make + $ LEAP_VENV_SKIP_PYSIDE=1 sudo python setup.py install +LEAP_VENV_SKIP_PYSIDE is used to avoid compiling PySide in the installation since it's already installed through the package manager. Running ------- -- cgit v1.2.3 From c6d61d489dbc2fb180932488f2f49d17a6f41d4a Mon Sep 17 00:00:00 2001 From: Tomas Touceda Date: Tue, 16 Apr 2013 10:51:48 -0300 Subject: We don't really need LEAP_VENV_SKIP_PYSIDE outside venv --- README.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 806e222c..95da7974 100644 --- a/README.rst +++ b/README.rst @@ -29,9 +29,7 @@ Installing After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:: $ make - $ LEAP_VENV_SKIP_PYSIDE=1 sudo python setup.py install - -LEAP_VENV_SKIP_PYSIDE is used to avoid compiling PySide in the installation since it's already installed through the package manager. + $ sudo python setup.py install Running ------- -- cgit v1.2.3 From 8e3e2ccb8d7d0302762f450d1acdf9576cc12a30 Mon Sep 17 00:00:00 2001 From: Tomas Touceda Date: Tue, 16 Apr 2013 11:04:03 -0300 Subject: Remove the last pyqt reference from the README --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 95da7974..5a60fcf0 100644 --- a/README.rst +++ b/README.rst @@ -62,7 +62,7 @@ Make sure you are in the development branch:: (leap_client)$ git checkout develop -Symlink your global pyqt libraries:: +Symlink your global pyside libraries:: (leap_client)$ pkg/postmkvenv.sh -- cgit v1.2.3 From 90cac3e4a992a513db96b6c126fdd5259e881d0f Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Tue, 16 Apr 2013 23:14:48 +0900 Subject: Remove first row, allow it to render. --- README.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 5a60fcf0..718b4e74 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,3 @@ -========================================= The LEAP Encryption Access Project Client ========================================= -- cgit v1.2.3 From 76641e028f4a8b6c5c89ad0e9ff4bfecc075d678 Mon Sep 17 00:00:00 2001 From: Tomas Touceda Date: Mon, 6 May 2013 15:05:12 -0300 Subject: Document how to skip PySide from installing from source --- README.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 718b4e74..63dfd83a 100644 --- a/README.rst +++ b/README.rst @@ -28,6 +28,7 @@ Installing After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:: $ make + $ export LEAP_VENV_SKIP_PYSIDE=1 # This will avoid building PySide from source $ sudo python setup.py install Running -- cgit v1.2.3 From 713c9f86cc5882e4fb09d518501ac0a5a95dc469 Mon Sep 17 00:00:00 2001 From: Tomas Touceda Date: Tue, 7 May 2013 11:12:52 -0300 Subject: Specify properly how to skip pyside in installation --- README.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 63dfd83a..887552b3 100644 --- a/README.rst +++ b/README.rst @@ -28,8 +28,7 @@ Installing After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:: $ make - $ export LEAP_VENV_SKIP_PYSIDE=1 # This will avoid building PySide from source - $ sudo python setup.py install + $ sudo LEAP_VENV_SKIP_PYSIDE=1 python setup.py install Running ------- -- cgit v1.2.3 From 0f77a09df54e38ef311c577297358a2563bfdd27 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Tue, 21 May 2013 11:56:50 -0300 Subject: Add command to run the client in hacking section Also document the --danger flag for the client run --- README.rst | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 887552b3..72448ca4 100644 --- a/README.rst +++ b/README.rst @@ -41,7 +41,11 @@ If you are testing a new provider and do not have a CA certificate chain tied to $ leap-client --danger -Beware this is only for testing, its usage is *highly* discouraged. +But **DO NOT use it on a regular bases**. + +**WARNING**: If you use the --danger flag you may be victim to a MITM_ attack without noticing. Use at your own risk. + +.. _MITM: http://en.wikipedia.org/wiki/Man-in-the-middle_attack Hacking ======= @@ -69,6 +73,16 @@ And make your working tree available to your pythonpath:: (leap_client)$ python setup.py develop +Run the client:: + + (leap_client)$ python src/leap/app.py -d + + +If you are testing a new provider that doesn't have the proper certificates yet, you can use --danger flag, but **DO NOT use it on a regular bases**. + +**WARNING**: If you use the --danger flag you may be victim to a MITM_ attack without noticing. Use at your own risk. + +.. _MITM: http://en.wikipedia.org/wiki/Man-in-the-middle_attack Testing ======= -- cgit v1.2.3 From c4ba840c7c0df81fa928bab2edd1f2a2e3379952 Mon Sep 17 00:00:00 2001 From: kali Date: Mon, 27 May 2013 21:42:10 +0900 Subject: adapt test suite to latest client code * fix run_tests * add tox.ini * cleanup/update requirements * fix coverage reports * add pypi badge --- README.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 72448ca4..7b4924ab 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,9 @@ The LEAP Encryption Access Project Client *your internet encryption toolkit* +.. image:: https://pypip.in/v/leap-client/badge.png + :target: https://crate.io/packages/leap.client + Dependencies ------------------ -- cgit v1.2.3