From fb12b715bd3ffd0dfcf2291d5cb5b2110607106e Mon Sep 17 00:00:00 2001 From: Ada Lovelace Date: Fri, 20 Mar 2015 12:39:07 -0700 Subject: [PATCH 1/5] added swig to list of dependencies to install in CONTRIBUTING.rst --- CONTRIBUTING.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 9cb73a654..4e206afa4 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -4,10 +4,14 @@ Hacking ======= In order to start hacking, you will first have to create a development -environment: +environment. Start by installing the required system packages: :: + sudo apt-get install python-2.7 python-pip swig +Now you can install the development packages in your virtualenv: + +:: ./venv/bin/python setup.py dev The code base, including your pull requests, **must** have 100% test statement From b288bcf4a691f62b33bc61269e5a32d481317f0b Mon Sep 17 00:00:00 2001 From: Ada Lovelace Date: Fri, 20 Mar 2015 13:15:29 -0700 Subject: [PATCH 2/5] include setup instructions in CONTRIBUTING.rst --- CONTRIBUTING.rst | 67 +++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 61 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4e206afa4..048cd2b10 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,15 +1,69 @@ +Prerequisites +============= + +The demo code is supported and known to work on **Ubuntu only** (even +closely related `Debian is known to fail`_). + +Therefore, prerequisites for other platforms listed below are provided +mainly for the :ref:`developers ` reference. + +In general: + +* `swig`_ is required for compiling `m2crypto`_ +* `augeas`_ is required for the ``python-augeas`` bindings + +.. _Debian is known to fail: https://github.com/letsencrypt/lets-encrypt-preview/issues/68 + +Ubuntu +------ + +:: + + sudo apt-get install python python-setuptools python-virtualenv python-dev \ + gcc swig dialog libaugeas0 libssl-dev libffi-dev \ + ca-certificates + +.. Please keep the above command in sync with .travis.yml (before_install) + +Mac OSX +------- + +:: + + sudo brew install augeas swig + + +Installation +============ + +:: + + virtualenv --no-site-packages -p python2 venv + ./venv/bin/python setup.py install + sudo ./venv/bin/letsencrypt + + +Usage +===== + +The letsencrypt commandline tool has a builtin help: + +:: + + ./venv/bin/letsencrypt --help + + +.. _augeas: http://augeas.net/ +.. _m2crypto: https://github.com/M2Crypto/M2Crypto +.. _swig: http://www.swig.org/ + .. _hacking: Hacking ======= In order to start hacking, you will first have to create a development -environment. Start by installing the required system packages: - -:: - sudo apt-get install python-2.7 python-pip swig - -Now you can install the development packages in your virtualenv: +environment. Start by installing the development packages: :: ./venv/bin/python setup.py dev @@ -29,6 +83,7 @@ The following tools are there to help you: .. _coding-style: +.. _setup instructions: https://letsencrypt.readthedocs.org/en/latest/using.html Coding style ============ From dee212fc90e530a8028a164806c62b42bd71c122 Mon Sep 17 00:00:00 2001 From: Ada Lovelace Date: Fri, 20 Mar 2015 13:23:44 -0700 Subject: [PATCH 3/5] fixes typos in CONTRIBUTING --- CONTRIBUTING.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 048cd2b10..ca3a4c92e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -5,7 +5,7 @@ The demo code is supported and known to work on **Ubuntu only** (even closely related `Debian is known to fail`_). Therefore, prerequisites for other platforms listed below are provided -mainly for the :ref:`developers ` reference. +mainly for the `hacking`_ reference. In general: @@ -66,10 +66,11 @@ In order to start hacking, you will first have to create a development environment. Start by installing the development packages: :: + ./venv/bin/python setup.py dev The code base, including your pull requests, **must** have 100% test statement -coverage **and** be compliant with the :ref:`coding-style`. +coverage **and** be compliant with the coding-style_. The following tools are there to help you: @@ -83,8 +84,6 @@ The following tools are there to help you: .. _coding-style: -.. _setup instructions: https://letsencrypt.readthedocs.org/en/latest/using.html - Coding style ============ From 75e4e5d48b14dc0954984aec01c8ecf7024fa3ff Mon Sep 17 00:00:00 2001 From: William Budington Date: Fri, 20 Mar 2015 20:56:44 +0000 Subject: [PATCH 4/5] Gitignore .swp for vim --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index e1dca3a57..f2cec0721 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ venv/ .tox/ .coverage m3 +*.swp From a7059e6818566b62e97fcca727fa00d34f37543a Mon Sep 17 00:00:00 2001 From: cooperq Date: Fri, 20 Mar 2015 15:13:49 -0700 Subject: [PATCH 5/5] replace text with link to docs --- CONTRIBUTING.rst | 64 +++--------------------------------------------- 1 file changed, 4 insertions(+), 60 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ca3a4c92e..bfd0a1c0f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,69 +1,12 @@ -Prerequisites -============= - -The demo code is supported and known to work on **Ubuntu only** (even -closely related `Debian is known to fail`_). - -Therefore, prerequisites for other platforms listed below are provided -mainly for the `hacking`_ reference. - -In general: - -* `swig`_ is required for compiling `m2crypto`_ -* `augeas`_ is required for the ``python-augeas`` bindings - -.. _Debian is known to fail: https://github.com/letsencrypt/lets-encrypt-preview/issues/68 - -Ubuntu ------- - -:: - - sudo apt-get install python python-setuptools python-virtualenv python-dev \ - gcc swig dialog libaugeas0 libssl-dev libffi-dev \ - ca-certificates - -.. Please keep the above command in sync with .travis.yml (before_install) - -Mac OSX -------- - -:: - - sudo brew install augeas swig - - -Installation -============ - -:: - - virtualenv --no-site-packages -p python2 venv - ./venv/bin/python setup.py install - sudo ./venv/bin/letsencrypt - - -Usage -===== - -The letsencrypt commandline tool has a builtin help: - -:: - - ./venv/bin/letsencrypt --help - - -.. _augeas: http://augeas.net/ -.. _m2crypto: https://github.com/M2Crypto/M2Crypto -.. _swig: http://www.swig.org/ - .. _hacking: Hacking ======= In order to start hacking, you will first have to create a development -environment. Start by installing the development packages: +environment. Start by `installing dependencies and setting up Let's Encrypt`_. + +Now you can install the development packages: :: @@ -82,6 +25,7 @@ The following tools are there to help you: - ``./venv/bin/tox -e lint`` checks the style of the whole project, while ``./venv/bin/pylint --rcfile=.pylintrc file`` will check a single `file` only. +.. _installing dependencies and setting up Let's Encrypt: https://letsencrypt.readthedocs.org/en/latest/using.html .. _coding-style: Coding style