From 4a6acd4ed143d6d43ad9a70c13694dbae0cbaf49 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 20:05:57 +0200 Subject: Update version --- docs/conf.py | 20 +++++---- src/leap/bitmask/__init__.py | 75 ++++++++++++++++++++++++++++++++++ src/leap/bitmask/util/__init__.py | 50 +---------------------- src/leap/bitmask/util/leap_argparse.py | 6 ++- 4 files changed, 91 insertions(+), 60 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 39f17d9b..082b4d67 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,11 +18,12 @@ import sys, os # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('../src')) sys.path.insert(0, os.path.abspath('../src/leap')) -sys.path.insert(0, os.path.abspath('../src/leap/crypto')) -sys.path.insert(0, os.path.abspath('../src/leap/keymanager')) -sys.path.insert(0, os.path.abspath('../src/leap/services')) -sys.path.insert(0, os.path.abspath('../src/leap/services/eip')) -sys.path.insert(0, os.path.abspath('../src/leap/util')) +sys.path.insert(0, os.path.abspath('../src/leap/bitmask')) +sys.path.insert(0, os.path.abspath('../src/leap/bitmask/crypto')) +sys.path.insert(0, os.path.abspath('../src/leap/bitmask/keymanager')) +sys.path.insert(0, os.path.abspath('../src/leap/bitmask/services')) +sys.path.insert(0, os.path.abspath('../src/leap/bitmask/services/eip')) +sys.path.insert(0, os.path.abspath('../src/leap/bitmask/util')) sys.path.insert(0, os.path.abspath( os.path.expanduser( @@ -58,17 +59,18 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'LEAP' -copyright = u'2012, The LEAP Encryption Access Project' +project = u'Bitmask' +copyright = u'2012-2013, The LEAP Encryption Access Project' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.2.1-dev1' +import leap.bitmask +version = leap.bitmask.__short_version__ # The full version, including alpha/beta/rc tags. -release = '0.2.1' +release = leap.bitmask.__version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/src/leap/bitmask/__init__.py b/src/leap/bitmask/__init__.py index e69de29b..ebdd53c4 100644 --- a/src/leap/bitmask/__init__.py +++ b/src/leap/bitmask/__init__.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# __init__.py +# Copyright (C) 2013 LEAP +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +""" +Init file for leap.bitmask + +Initializes version and app info. +""" +import re + +from pkg_resources import parse_version + +from leap.bitmask.util import first + + +def _is_release_version(version): + """ + Helper to determine whether a version is a final release or not. + The release needs to be of the form: w.x.y.z containing only numbers + and dots. + + :param version: the version string + :type version: str + :returns: if the version is a release version or not. + :rtype: bool + """ + parsed_version = parse_version(version) + not_number = 0 + for x in parsed_version: + try: + int(x) + except: + not_number += 1 + + return not_number == 1 + + +__version__ = "unknown" +IS_RELEASE_VERSION = False + +__short_version__ = "unknown" + +try: + from leap.bitmask._version import get_versions + __version__ = get_versions()['version'] + IS_RELEASE_VERSION = _is_release_version(__version__) + del get_versions +except ImportError: + #running on a tree that has not run + #the setup.py setver + pass + +__appname__ = "unknown" +try: + from leap._appname import __appname__ +except ImportError: + #running on a tree that has not run + #the setup.py setver + pass + +__short_version__ = first(re.findall('\d\.\d\.\d', __version__)) +__full_version__ = __appname__ + '/' + str(__version__) diff --git a/src/leap/bitmask/util/__init__.py b/src/leap/bitmask/util/__init__.py index ce8323cd..6dd18bcf 100644 --- a/src/leap/bitmask/util/__init__.py +++ b/src/leap/bitmask/util/__init__.py @@ -15,59 +15,11 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . """ -Initializes version and app info, plus some small and handy functions. +Some small and handy functions. """ import datetime import os -from pkg_resources import parse_version - - -def _is_release_version(version): - """ - Helper to determine whether a version is a final release or not. - The release needs to be of the form: w.x.y.z containing only numbers - and dots. - - :param version: the version string - :type version: str - :returns: if the version is a release version or not. - :rtype: bool - """ - parsed_version = parse_version(version) - not_number = 0 - for x in parsed_version: - try: - int(x) - except: - not_number += 1 - - return not_number == 1 - - -__version__ = "unknown" -IS_RELEASE_VERSION = False - -try: - from leap.bitmask._version import get_versions - __version__ = get_versions()['version'] - IS_RELEASE_VERSION = _is_release_version(__version__) - del get_versions -except ImportError: - #running on a tree that has not run - #the setup.py setver - pass - -__appname__ = "unknown" -try: - from leap._appname import __appname__ -except ImportError: - #running on a tree that has not run - #the setup.py setver - pass - -__full_version__ = __appname__ + '/' + str(__version__) - def first(things): """ diff --git a/src/leap/bitmask/util/leap_argparse.py b/src/leap/bitmask/util/leap_argparse.py index 71f5163d..bc21a9cf 100644 --- a/src/leap/bitmask/util/leap_argparse.py +++ b/src/leap/bitmask/util/leap_argparse.py @@ -14,10 +14,12 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . - +""" +Parses the command line arguments passed to the application. +""" import argparse -from leap.bitmask.util import IS_RELEASE_VERSION +from leap.bitmask import IS_RELEASE_VERSION def build_parser(): -- cgit v1.2.3 From 1782f6328de41a19dfa8e81f30b9fe31c1a0d34c Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 21:37:25 +0200 Subject: Images shuffle --- data/images/favicon.ico | Bin 318 -> 1150 bytes data/images/leap-color-small.png | Bin 10100 -> 0 bytes data/images/mask-small.png | Bin 0 -> 18172 bytes data/images/watermark.png | Bin 22819 -> 0 bytes docs/user/leap-color-small.png | Bin 0 -> 10100 bytes 5 files changed, 0 insertions(+), 0 deletions(-) delete mode 100644 data/images/leap-color-small.png create mode 100644 data/images/mask-small.png delete mode 100644 data/images/watermark.png create mode 100644 docs/user/leap-color-small.png diff --git a/data/images/favicon.ico b/data/images/favicon.ico index b5f3505a..7f41dd1d 100644 Binary files a/data/images/favicon.ico and b/data/images/favicon.ico differ diff --git a/data/images/leap-color-small.png b/data/images/leap-color-small.png deleted file mode 100644 index bc9d4e7f..00000000 Binary files a/data/images/leap-color-small.png and /dev/null differ diff --git a/data/images/mask-small.png b/data/images/mask-small.png new file mode 100644 index 00000000..5f5f1b41 Binary files /dev/null and b/data/images/mask-small.png differ diff --git a/data/images/watermark.png b/data/images/watermark.png deleted file mode 100644 index d8e3f965..00000000 Binary files a/data/images/watermark.png and /dev/null differ diff --git a/docs/user/leap-color-small.png b/docs/user/leap-color-small.png new file mode 100644 index 00000000..bc9d4e7f Binary files /dev/null and b/docs/user/leap-color-small.png differ -- cgit v1.2.3 From 1fd9b7cffaf1063c3a2a23e056556be18ef3848a Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 21:38:02 +0200 Subject: Update intro --- docs/Makefile | 1 + docs/conf.py | 15 +++++++++------ docs/index.rst | 16 +++++++++++----- docs/user/intro.rst | 18 ++++++++++++++---- pkg/requirements-docs.pip | 1 + 5 files changed, 36 insertions(+), 15 deletions(-) create mode 100644 pkg/requirements-docs.pip diff --git a/docs/Makefile b/docs/Makefile index 16aa258b..5c2c4145 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,6 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build +#SPHINXBUILD = $(VIRTUAL_ENV)/bin/sphinx-build PAPER = BUILDDIR = _build diff --git a/docs/conf.py b/docs/conf.py index 082b4d67..3c908b2c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# LEAP documentation build configuration file, created by +# Bitmask documentation build configuration file, created by # sphinx-quickstart on Sun Jul 22 18:32:05 2012. # # This file is execfile()d with the current directory set to its containing dir. @@ -25,10 +25,13 @@ sys.path.insert(0, os.path.abspath('../src/leap/bitmask/services')) sys.path.insert(0, os.path.abspath('../src/leap/bitmask/services/eip')) sys.path.insert(0, os.path.abspath('../src/leap/bitmask/util')) -sys.path.insert(0, os.path.abspath( - os.path.expanduser( - '~/Virtualenvs/leap-client/local/lib/python2.7/' - 'site-packages/leap/common'))) +try: + sys.path.insert(0, os.path.abspath( + os.path.expanduser( + '~/Virtualenvs/leap-bitmask/local/lib/python2.7/' + 'site-packages/leap/common'))) +except: + pass # TODO: should add all the virtualenv site-packages to the path # as a workaround, install all in your path. @@ -130,7 +133,7 @@ html_theme = 'default' # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = "../data/images/leap-color-small.png" +html_logo = "../data/images/mask-small.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 diff --git a/docs/index.rst b/docs/index.rst index e3078929..d0b0ff22 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,15 +1,20 @@ -.. LEAP documentation master file, created by +.. Bitmask documentation master file, created by sphinx-quickstart on Sun Jul 22 18:32:05 2012. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -LEAP Client +Bitmask ===================================== -Release v\ |version|. (`Impatient? jump to the` :ref:`Installation ` `section!`) +Release v \ |version|. (`Impatient? jump to the` :ref:`Installation ` `section!`) .. if you change this paragraph, change it in user/intro too -The **LEAP Encryption Access Project Client** is a :ref:`GPL3 Licensed ` multiplatform client, written in python using PySide, that supports the features offered by :ref:`the LEAP Platform `. Currently is being tested on Linux, support for OSX and Windows will come soon. +**Bitmask** is the multiplatform desktop client for the services offered by :ref:`the LEAP Platform `. +It is written in python using `PySide`_ and :ref:`licensed under the GPL3 `. +Currently we distribute pre-compiled bundles for Linux and OSX, with Windows +bundles following soon. + +.. _`PySide`: http://qt-project.org/wiki/PySide User Guide ---------- @@ -48,7 +53,6 @@ If you want to contribute to the project, we wrote this for you. .. dev/internals dev/authors dev/todo - dev/workflow Packager Guide --------------- @@ -87,3 +91,5 @@ If you are looking for a reference to specific classes or functions, you are lik :maxdepth: 2 api/leap + + diff --git a/docs/user/intro.rst b/docs/user/intro.rst index 22ad9356..b93df12b 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -6,26 +6,34 @@ Introduction Bitmask ------- .. if yoy change this, change it also in the index.rst -**Bitmask** is a :ref:`GPL3 Licensed ` multiplatform client, written in python using PySide, that supports the features offered by :ref:`the LEAP Platform `. Currently is being tested on Linux, support for OSX and Windows will come soon. +**Bitmask** is the multiplatform desktop client for the services offered by :ref:`the LEAP Platform `. +It is written in python using `PySide`_ and :ref:`licensed under the GPL3 `. +Currently we distribute pre-compiled bundles for Linux and OSX, with Windows +bundles following soon. Features ^^^^^^^^ Bitmask allows to easily secure communications. -- Provider selection -- User registration +- Provider selection. +- User registration. - Encrypted Internet Proxy support (autoconfigured service using openvpn). +- Encrypted email. Coming soon ^^^^^^^^^^^^ -- Encrypted email +- Encrypted chat. + .. _leapplatform: The LEAP Platform ^^^^^^^^^^^^^^^^^ + +.. image:: leap-color-small.* + The LEAP Provider Platform is the server-side part of LEAP that is run by service providers. It consists of a set of complementary packages and recipes to automate the maintenance of LEAP services in a hardened GNU/Linux environment. Our goal is to make it painless for service providers and ISPs to deploy a secure communications platform. Read `more about the LEAP Platform `_ or `check out the code `_. @@ -97,5 +105,7 @@ Bitmask is released under the terms of the `GNU GPL version 3`_ or later. .. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt +.. _`PySide`: http://qt-project.org/wiki/PySide + .. ??? include whole version? .. include:: ../COPYING diff --git a/pkg/requirements-docs.pip b/pkg/requirements-docs.pip new file mode 100644 index 00000000..6966869c --- /dev/null +++ b/pkg/requirements-docs.pip @@ -0,0 +1 @@ +sphinx -- cgit v1.2.3 From d25647171fcaea39d28d60ed9b00c89555e8d9c8 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 22:17:45 +0200 Subject: Update readme * Read the docs * Fix path to gpl image until we switch repos --- README.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 7c415663..5d601578 100644 --- a/README.rst +++ b/README.rst @@ -6,6 +6,13 @@ The LEAP Encryption Access Project Client .. image:: https://pypip.in/v/leap.bitmask/badge.png :target: https://crate.io/packages/leap.bitmask +Read the Docs! +------------------ + +The latest documentation is available at `Read The Docs`_. + +.. _`RTD`: http://bitmask.rtfd.org + Dependencies ------------------ @@ -101,7 +108,7 @@ which the first time should automagically install all the needed dependencies in License ======= -.. image:: https://raw.github.com/leapcode/bitmask/develop/docs/user/gpl.png +.. image:: https://raw.github.com/leapcode/leap_client/develop/docs/user/gpl.png Bitmask is released under the terms of the `GNU GPL version 3`_ or later. -- cgit v1.2.3 From 9d4c219cdfc331286f6650fd746c75fcd3e0ce35 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Wed, 4 Sep 2013 16:55:37 -0300 Subject: Add install:bundle section. --- docs/user/install.rst | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/docs/user/install.rst b/docs/user/install.rst index da1d914c..2a597c8b 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -8,24 +8,51 @@ We assume that you want to get it properly installed before being able to use it .. note:: - The recommended way of installing in the near future will be the standalone bundles, but those are not quite ready yet. Methods described in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. You can refer to the sections :ref:`setting up a working environment ` or :ref:`fetching latest code for testing `. + Methods described in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. You can refer to the sections :ref:`setting up a working environment ` or :ref:`fetching latest code for testing `. +Standalone bundle +----------------- + +You can run Bitmask using the standalone bundle, the recommended way to use Bitmask. + +For the latest bundles and its signatures in https://downloads.leap.se/client/ + +Linux 32 bits: + https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2 + + https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2.asc + +Linux 64 bits: + https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2 + + https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2.asc + +OSX: + https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg + + https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg.asc + +Windows version is delayed right now. + +For the signature verification you can use :: + + $ gpg --verify Bitmask-linux64-0.3.1.tar.bz2.asc + +Asuming that you downloaded the linux 64 bits bundle. Distribute & Pip ---------------- -.. warning:: The package in the cheese shop is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead. - Installing Bitmask is as simple as using `pip `_ for the already released versions :: - $ pip install bitmask + $ pip install leap.bitmask Debian package -------------- .. warning:: - The debian package in the leap repositories is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead, + The debian package in the leap repositories is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead. First, you need to bootstrap your apt-key:: -- cgit v1.2.3 From 7be4076e349568c12ddcd903365b41bd7e88ee74 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 22:30:35 +0200 Subject: Update checklist with symlinks info --- docs/release_checklist.wiki | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/release_checklist.wiki b/docs/release_checklist.wiki index e766d6f8..5db34329 100644 --- a/docs/release_checklist.wiki +++ b/docs/release_checklist.wiki @@ -1,4 +1,5 @@ = Bitmask Release Checklist (*) = + * [ ] Check that all tests are passing! * [ ] Tag everything * Should be done for the following packages, in order: 1. leap.common @@ -24,10 +25,13 @@ * [ ] git push origin X.Y.Z * [ ] git checkout master && git pull origin master && git merge release-X.Y.Z && git push origin master * [ ] git checkout develop && git pull origin develop && git merge release-X.Y.Z && git push origin develop - * [ ] Build bundles + * [ ] Build and upload bundles * [ ] Use the scripts under pkg// to build the the bundles. * [ ] Sign them with gpg -a * [ ] Upload bundle and signature to web-uploads@salmon.leap.se:~/public/client// + * [ ] Update symbolic link for latest upload and signature: + * [ ] ~/public/client/latest- + * [ ] ~/public/client/latest-.asc * [ ] Announce * [ ] Mail leap@lists.riseup.net -- cgit v1.2.3 From f00463b3dd05d7c060d91d1d6898b1a704090662 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:00:42 +0200 Subject: Reformat links to downloads with symlinks --- docs/release_checklist.wiki | 6 ++--- docs/user/install.rst | 62 ++++++++++++++++++++++++++------------------- 2 files changed, 39 insertions(+), 29 deletions(-) diff --git a/docs/release_checklist.wiki b/docs/release_checklist.wiki index 5db34329..e6467048 100644 --- a/docs/release_checklist.wiki +++ b/docs/release_checklist.wiki @@ -28,10 +28,10 @@ * [ ] Build and upload bundles * [ ] Use the scripts under pkg// to build the the bundles. * [ ] Sign them with gpg -a - * [ ] Upload bundle and signature to web-uploads@salmon.leap.se:~/public/client// + * [ ] Upload bundle and signature to web-uploads@salmon.leap.se:~/public/client//Bitmask--.(tar.bz2,dmg,zip) * [ ] Update symbolic link for latest upload and signature: - * [ ] ~/public/client/latest- - * [ ] ~/public/client/latest-.asc + * [ ] ~/public/client/Bitmask--latest + * [ ] ~/public/client/Bitmask--latest.asc * [ ] Announce * [ ] Mail leap@lists.riseup.net diff --git a/docs/user/install.rst b/docs/user/install.rst index 2a597c8b..37a1713e 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -6,53 +6,50 @@ Installation This part of the documentation covers the installation of Bitmask. We assume that you want to get it properly installed before being able to use it. -.. note:: - - Methods described in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. You can refer to the sections :ref:`setting up a working environment ` or :ref:`fetching latest code for testing `. - Standalone bundle ----------------- -You can run Bitmask using the standalone bundle, the recommended way to use Bitmask. +Maybe the quickest way of running Bitmask in your machine is using the standalone bundle. That is the recommended way to use Bitmask for the time being. -For the latest bundles and its signatures in https://downloads.leap.se/client/ +You can get the latest bundles, and their matching signatures at `the downloads page `_. -Linux 32 bits: - https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2 +Linux +^^^^^ +- `Linux 32 bits bundle`_ (`signature `_) +- `Linux 64 bits bundle`_ (`signature `_) - https://downloads.leap.se/client/linux/Bitmask-linux32-0.3.1.tar.bz2.asc +OSX +^^^ +- `OSX bundle`_ (`signature `_) -Linux 64 bits: - https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2 - - https://downloads.leap.se/client/linux/Bitmask-linux64-0.3.1.tar.bz2.asc - -OSX: - https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg +Windows +^^^^^^^ +.. note:: - https://downloads.leap.se/client/osx/Bitmask-OSX-0.3.1.dmg.asc + The release of the bundles for Windows is delayed right now. We should resume + producing them shortly, keep tuned. -Windows version is delayed right now. +Signature verification +^^^^^^^^^^^^^^^^^^^^^^ For the signature verification you can use :: - $ gpg --verify Bitmask-linux64-0.3.1.tar.bz2.asc + $ gpg --verify Bitmask-linux64-latest.tar.bz2.asc Asuming that you downloaded the linux 64 bits bundle. -Distribute & Pip ----------------- - -Installing Bitmask is as simple as using `pip `_ for the already released versions :: - - $ pip install leap.bitmask +.. _`PySide`: http://qt-project.org/wiki/PySide +.. _`Linux 64 bits bundle`: https://downloads.leap.se/client/linux/Bitmask-linux64-latest.tar.bz2 +.. _`Linux 32 bits bundle`: https://downloads.leap.se/client/linux/Bitmask-linux32-latest.tar.bz2 +.. _`OSX bundle`: https://downloads.leap.se/client/osx/Bitmask-OSX-latest.dmg +.. _`Windows bundle`: https://downloads.leap.se/client/osx/Bitmask-windows-latest.zip Debian package -------------- .. warning:: - The debian package in the leap repositories is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead. + The debian package that you can currently find in the leap repositories is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version or the standalone bundles while we upload the newest packages. First, you need to bootstrap your apt-key:: @@ -71,6 +68,19 @@ And then you can happily install bitmask:: apt-get install bitmask +Distribute & Pip +---------------- + +.. note:: + + The rest of the methods described below in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. For more insight, you can also refer to the sections :ref:`setting up a working environment ` or :ref:`fetching latest code for testing `. + + +Installing Bitmask is as simple as using `pip `_ for the already released versions :: + + $ pip install leap.bitmask + + Show me the code! ----------------- -- cgit v1.2.3 From e50ff1f5b82f004b3a38cdc366aa021a7e987c23 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:07:16 +0200 Subject: Revert repo names for the moment --- docs/user/install.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/user/install.rst b/docs/user/install.rst index 37a1713e..d6354dab 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -4,7 +4,7 @@ Installation ============ This part of the documentation covers the installation of Bitmask. -We assume that you want to get it properly installed before being able to use it. +We assume that you want to get it properly installed before being able to use it. But we can we wrong. Standalone bundle ----------------- @@ -38,11 +38,10 @@ For the signature verification you can use :: Asuming that you downloaded the linux 64 bits bundle. -.. _`PySide`: http://qt-project.org/wiki/PySide .. _`Linux 64 bits bundle`: https://downloads.leap.se/client/linux/Bitmask-linux64-latest.tar.bz2 .. _`Linux 32 bits bundle`: https://downloads.leap.se/client/linux/Bitmask-linux32-latest.tar.bz2 .. _`OSX bundle`: https://downloads.leap.se/client/osx/Bitmask-OSX-latest.dmg -.. _`Windows bundle`: https://downloads.leap.se/client/osx/Bitmask-windows-latest.zip +.. _`Windows bundle`: https://downloads.leap.se/client/windows/Bitmask-windows-latest.zip Debian package -------------- @@ -84,15 +83,16 @@ Installing Bitmask is as simple as using `pip `_ Show me the code! ----------------- +.. XXX UPDATE REPO NAMES AS SOON AS #3417 is DONE + You can get the code from LEAP public git repository :: - $ git clone git://leap.se/bitmask + $ git clone git://leap.se/leap_client Or from the github mirror :: - $ git clone git://github.com/leapcode/bitmask.git + $ git clone git://github.com/leapcode/leap_client.git Once you have grabbed a copy of the sources, you can install it into your site-packages easily :: $ pyton setup.py install - -- cgit v1.2.3 From c33094f4216b4ef21f25bf448904839d8d50a2f0 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:15:11 +0200 Subject: Minor additions --- docs/user/running.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/user/running.rst b/docs/user/running.rst index da83e9ef..0a93204c 100644 --- a/docs/user/running.rst +++ b/docs/user/running.rst @@ -3,7 +3,8 @@ Running ================== -This document covers how to launch Bitmask. +This document covers how to launch Bitmask. Also know as, where the magic +happens. Launching Bitmask ----------------- @@ -11,7 +12,7 @@ After a successful installation, there should be a launcher called `bitmask` som % bitmask -The first time you launch it, it should launch the first run wizard that will guide you through the setup of the LEAP Services. +The first time you launch it, it should launch the first run wizard that will guide you through the mostly automatic configuration of the LEAP Services. .. note:: @@ -37,8 +38,8 @@ If you ask for it, you can also have all that debug info in a beautiful file rea .. If you want to increment the level of verbosity passed to openvpn, you can do:: .. $ bitmask --openvpn-verbosity 4 -Options ------------- +I want all the options! +----------------------- To see all the available command line options:: $ bitmask --help -- cgit v1.2.3 From 261de005c0a2ecbc8ef4a7771cfeb2a853cbc00d Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:18:23 +0200 Subject: Add pypi version icon in user/install --- docs/user/install.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/user/install.rst b/docs/user/install.rst index d6354dab..b5fb7810 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -74,6 +74,9 @@ Distribute & Pip The rest of the methods described below in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. For more insight, you can also refer to the sections :ref:`setting up a working environment ` or :ref:`fetching latest code for testing `. +.. image:: https://pypip.in/v/leap.bitmask/badge.png + :target: https://crate.io/packages/leap.bitmask + Installing Bitmask is as simple as using `pip `_ for the already released versions :: -- cgit v1.2.3 From e497e3bd99020f26dcfae3e0fa815179284a8050 Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 4 Sep 2013 23:26:54 +0200 Subject: Fix README link to rtd --- README.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 5d601578..f8308566 100644 --- a/README.rst +++ b/README.rst @@ -1,17 +1,26 @@ -The LEAP Encryption Access Project Client -========================================= - +Bitmask +======= *your internet encryption toolkit* .. image:: https://pypip.in/v/leap.bitmask/badge.png :target: https://crate.io/packages/leap.bitmask +**Bitmask** is the multiplatform desktop client for the services offered by +`the LEAP Platform`_. +It is written in python using `PySide`_ and licensed under the GPL3. +Currently we distribute pre-compiled bundles for Linux and OSX, with Windows +bundles following soon. + +.. _`PySide`: http://qt-project.org/wiki/PySide +.. _`the LEAP Platform`: https://github.com/leapcode/leap_platform + + Read the Docs! ------------------ The latest documentation is available at `Read The Docs`_. -.. _`RTD`: http://bitmask.rtfd.org +.. _`Read The Docs`: http://bitmask.rtfd.org Dependencies ------------------ @@ -62,7 +71,7 @@ Hacking The Bitmask git repository is available at:: - git://leap.se/bitmask + git://leap.se/leap_client Some steps need to be run when setting a development environment for the first time. -- cgit v1.2.3