starred/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-08-01 18:56:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document tests/integration/_common.sh.

Browse Source 
This makes it much easier to run certbot during development.
This commit is contained in:
Jacob Hoffman-Andrews
2017-03-28 16:15:09 -07:00
parent 018a304cd6
commit db0a4f9039
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/contributing.rst
+8 -8
View File
@@ -39,17 +39,17 @@ Then in each shell where you're working on the client, do:
.. code-block:: shell .. code-block:: shell
source ./venv/bin/activate source ./venv/bin/activate
. tests/integration/_common.sh
After that, your shell will be using the virtual environment, and you run the After that, your shell will be using the virtual environment, and you run the
client by typing: client by typing `certbot` or `certbot_test`. The latter is an alias that
includes several flags useful for testing. For instance, it sets various output
directories to point to /tmp/, and uses non-privileged ports for challenges, so
root privileges are not required.
.. code-block:: shell Activating a shell with `venv/bin/activate` sets environment variables so that
Python pulls in the correct versions of various packages needed by Certbot.
certbot More information can be found in the `virtualenv docs`_.
Activating a shell in this way makes it easier to run unit tests
with ``tox`` and integration tests, as described below. To reverse this, you
can type ``deactivate``. More information can be found in the `virtualenv docs`_.
.. _`virtualenv docs`: https://virtualenv.pypa.io .. _`virtualenv docs`: https://virtualenv.pypa.io