rename letshelp-letsencrypt

This commit is contained in:
Brad Warren
2016-04-13 17:42:19 -07:00
parent 0ce45a77f9
commit 214343ed6a
29 changed files with 61 additions and 60 deletions
@@ -1,4 +1,4 @@
include LICENSE.txt include LICENSE.txt
include README.rst include README.rst
recursive-include docs * recursive-include docs *
recursive-include letshelp_letsencrypt/testdata * recursive-include letshelp_certbot/testdata *
+1
View File
@@ -0,0 +1 @@
Let's help Certbot client
@@ -87,9 +87,9 @@ qthelp:
@echo @echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:" ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/letshelp-letsencrypt.qhcp" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/letshelp-certbot.qhcp"
@echo "To view the help file:" @echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/letshelp-letsencrypt.qhc" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/letshelp-certbot.qhc"
applehelp: applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@@ -104,8 +104,8 @@ devhelp:
@echo @echo
@echo "Build finished." @echo "Build finished."
@echo "To view the help file:" @echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/letshelp-letsencrypt" @echo "# mkdir -p $$HOME/.local/share/devhelp/letshelp-certbot"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/letshelp-letsencrypt" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/letshelp-certbot"
@echo "# devhelp" @echo "# devhelp"
epub: epub:
+11
View File
@@ -0,0 +1,11 @@
:mod:`letshelp_certbot`
---------------------------
.. automodule:: letshelp_certbot
:members:
:mod:`letshelp_certbot.apache`
==================================
.. automodule:: letshelp_certbot.apache
:members:
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# #
# letshelp-letsencrypt documentation build configuration file, created by # letshelp-certbot documentation build configuration file, created by
# sphinx-quickstart on Sun Oct 18 13:40:19 2015. # sphinx-quickstart on Sun Oct 18 13:40:19 2015.
# #
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
@@ -58,7 +58,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'letshelp-letsencrypt' project = u'letshelp-certbot'
copyright = u'2014-2015, Let\'s Encrypt Project' copyright = u'2014-2015, Let\'s Encrypt Project'
author = u'Let\'s Encrypt Project' author = u'Let\'s Encrypt Project'
@@ -220,7 +220,7 @@ html_static_path = ['_static']
#html_search_scorer = 'scorer.js' #html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'letshelp-letsencryptdoc' htmlhelp_basename = 'letshelp-certbotdoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
@@ -242,7 +242,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'letshelp-letsencrypt.tex', u'letshelp-letsencrypt Documentation', (master_doc, 'letshelp-certbot.tex', u'letshelp-certbot Documentation',
u'Let\'s Encrypt Project', 'manual'), u'Let\'s Encrypt Project', 'manual'),
] ]
@@ -272,7 +272,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'letshelp-letsencrypt', u'letshelp-letsencrypt Documentation', (master_doc, 'letshelp-certbot', u'letshelp-certbot Documentation',
[author], 1) [author], 1)
] ]
@@ -286,8 +286,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'letshelp-letsencrypt', u'letshelp-letsencrypt Documentation', (master_doc, 'letshelp-certbot', u'letshelp-certbot Documentation',
author, 'letshelp-letsencrypt', 'One line description of project.', author, 'letshelp-certbot', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]
@@ -307,5 +307,5 @@ texinfo_documents = [
intersphinx_mapping = { intersphinx_mapping = {
'python': ('https://docs.python.org/', None), 'python': ('https://docs.python.org/', None),
'acme': ('https://acme-python.readthedocs.org/en/latest/', None), 'acme': ('https://acme-python.readthedocs.org/en/latest/', None),
'letsencrypt': ('https://letsencrypt.readthedocs.org/en/latest/', None), 'certbot': ('https://letsencrypt.readthedocs.org/en/latest/', None),
} }
@@ -1,9 +1,9 @@
.. letshelp-letsencrypt documentation master file, created by .. letshelp-certbot documentation master file, created by
sphinx-quickstart on Sun Oct 18 13:40:19 2015. sphinx-quickstart on Sun Oct 18 13:40:19 2015.
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to letshelp-letsencrypt's documentation! Welcome to letshelp-certbot's documentation!
================================================ ================================================
Contents: Contents:
@@ -127,9 +127,9 @@ if "%1" == "qthelp" (
echo. echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^ echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this: .qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\letshelp-letsencrypt.qhcp echo.^> qcollectiongenerator %BUILDDIR%\qthelp\letshelp-certbot.qhcp
echo.To view the help file: echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\letshelp-letsencrypt.ghc echo.^> assistant -collectionFile %BUILDDIR%\qthelp\letshelp-certbot.ghc
goto end goto end
) )
@@ -1,5 +1,5 @@
#!/usr/bin/env python #!/usr/bin/env python
"""Let's Encrypt Apache configuration submission script""" """Certbot Apache configuration submission script"""
from __future__ import print_function from __future__ import print_function
@@ -17,12 +17,12 @@ import textwrap
_DESCRIPTION = """ _DESCRIPTION = """
Let's Help is a simple script you can run to help out the Let's Encrypt Let's Help is a simple script you can run to help out the Certbot
project. Since Let's Encrypt will support automatically configuring HTTPS on project. Since Certbot will support automatically configuring HTTPS on
many servers, we want to test this functionality on as many configurations as many servers, we want to test this functionality on as many configurations as
possible. This script will create a sanitized copy of your Apache possible. This script will create a sanitized copy of your Apache
configuration, notifying you of the files that have been selected. If (and only configuration, notifying you of the files that have been selected. If (and only
if) you approve this selection, these files will be sent to the Let's Encrypt if) you approve this selection, these files will be sent to the Certbot
developers. developers.
""" """
@@ -38,8 +38,9 @@ argument and the path to the binary.
# Keywords likely to be found in filenames of sensitive files # Keywords likely to be found in filenames of sensitive files
_SENSITIVE_FILENAME_REGEX = re.compile(r"^(?!.*proxy_fdpass).*pass.*$|private|" _SENSITIVE_FILENAME_REGEX = re.compile(r"^(?!.*proxy_fdpass).*pass.*$|private|"
r"secret|cert|crt|key|rsa|dsa|pw|\.pem|" r"secret|^(?!.*certbot).*cert.*$|crt|"
r"\.der|\.p12|\.pfx|\.p7b") r"key|rsa|dsa|pw|\.pem|\.der|\.p12|"
r"\.pfx|\.p7b")
def make_and_verify_selection(server_root, temp_dir): def make_and_verify_selection(server_root, temp_dir):
@@ -1,4 +1,4 @@
"""Tests for letshelp.letshelp_letsencrypt_apache.py""" """Tests for letshelp.letshelp_certbot_apache.py"""
import argparse import argparse
import functools import functools
import os import os
@@ -10,7 +10,7 @@ import unittest
import mock import mock
import letshelp_letsencrypt.apache as letshelp_le_apache import letshelp_certbot.apache as letshelp_le_apache
_PARTIAL_CONF_PATH = os.path.join("mods-available", "ssl.load") _PARTIAL_CONF_PATH = os.path.join("mods-available", "ssl.load")
@@ -25,7 +25,7 @@ _SECRET_FILE = pkg_resources.resource_filename(
__name__, os.path.join("testdata", "super_secret_file.txt")) __name__, os.path.join("testdata", "super_secret_file.txt"))
_MODULE_NAME = "letshelp_letsencrypt.apache" _MODULE_NAME = "letshelp_certbot.apache"
_COMPILE_SETTINGS = """Server version: Apache/2.4.10 (Debian) _COMPILE_SETTINGS = """Server version: Apache/2.4.10 (Debian)
@@ -7,4 +7,4 @@
# in --editable mode (-e), just "pip install .[docs]" does not work as # in --editable mode (-e), just "pip install .[docs]" does not work as
# expected and "pip install -e .[docs]" must be used instead # expected and "pip install -e .[docs]" must be used instead
-e letshelp-letsencrypt[docs] -e letshelp-certbot[docs]
@@ -20,11 +20,11 @@ docs_extras = [
] ]
setup( setup(
name='letshelp-letsencrypt', name='letshelp-certbot',
version=version, version=version,
description="Let's help Let's Encrypt client", description="Let's help Certbot client",
url='https://github.com/letsencrypt/letsencrypt', url='https://github.com/letsencrypt/letsencrypt',
author="Let's Encrypt Project", author="Electronic Frontier Foundation",
author_email='client-dev@letsencrypt.org', author_email='client-dev@letsencrypt.org',
license='Apache License 2.0', license='Apache License 2.0',
classifiers=[ classifiers=[
@@ -52,8 +52,8 @@ setup(
}, },
entry_points={ entry_points={
'console_scripts': [ 'console_scripts': [
'letshelp-letsencrypt-apache = letshelp_letsencrypt.apache:main', 'letshelp-certbot-apache = letshelp_certbot.apache:main',
], ],
}, },
test_suite='letshelp_letsencrypt', test_suite='letshelp_certbot',
) )
-1
View File
@@ -1 +0,0 @@
Let's help Let's Encrypt client
-11
View File
@@ -1,11 +0,0 @@
:mod:`letshelp_letsencrypt`
---------------------------
.. automodule:: letshelp_letsencrypt
:members:
:mod:`letshelp_letsencrypt.apache`
==================================
.. automodule:: letshelp_letsencrypt.apache
:members:
+2 -2
View File
@@ -3,8 +3,8 @@
VENV_NAME=${VENV_NAME:-venv} VENV_NAME=${VENV_NAME:-venv}
# .egg-info directories tend to cause bizzaire problems (e.g. `pip -e # .egg-info directories tend to cause bizzaire problems (e.g. `pip -e
# .` might unexpectedly install letshelp-letsencrypt only, in case # .` might unexpectedly install letshelp-certbot only, in case
# `python letshelp-letsencrypt/setup.py build` has been called # `python letshelp-certbot/setup.py build` has been called
# earlier) # earlier)
rm -rf *.egg-info rm -rf *.egg-info
+2 -2
View File
@@ -2,9 +2,9 @@
# #
# Find all Python imports. # Find all Python imports.
# #
# ./tools/deps.sh letsencrypt # ./tools/deps.sh certbot
# ./tools/deps.sh acme # ./tools/deps.sh acme
# ./tools/deps.sh letsencrypt-apache # ./tools/deps.sh certbot-apache
# ... # ...
# #
# Manually compare the output with deps in setup.py. # Manually compare the output with deps in setup.py.
+4 -4
View File
@@ -6,7 +6,7 @@ export VENV_ARGS="--python python2"
./tools/_venv_common.sh \ ./tools/_venv_common.sh \
-e acme[dev] \ -e acme[dev] \
-e .[dev,docs] \ -e .[dev,docs] \
-e letsencrypt-apache \ -e certbot-apache \
-e letsencrypt-nginx \ -e certbot-nginx \
-e letshelp-letsencrypt \ -e letshelp-certbot \
-e letsencrypt-compatibility-test -e certbot-compatibility-test
+2 -2
View File
@@ -9,7 +9,7 @@
# -e makes sure we fail fast and don't submit coveralls submit # -e makes sure we fail fast and don't submit coveralls submit
if [ "xxx$1" = "xxx" ]; then if [ "xxx$1" = "xxx" ]; then
pkgs="certbot acme certbot_apache certbot_nginx letshelp_letsencrypt" pkgs="certbot acme certbot_apache certbot_nginx letshelp_certbot"
else else
pkgs="$@" pkgs="$@"
fi fi
@@ -23,7 +23,7 @@ cover () {
min=100 min=100
elif [ "$1" = "certbot_nginx" ]; then elif [ "$1" = "certbot_nginx" ]; then
min=97 min=97
elif [ "$1" = "letshelp_letsencrypt" ]; then elif [ "$1" = "letshelp_certbot" ]; then
min=100 min=100
else else
echo "Unrecognized package: $1" echo "Unrecognized package: $1"
+6 -6
View File
@@ -21,8 +21,8 @@ commands =
nosetests -v certbot_apache nosetests -v certbot_apache
pip install -e certbot-nginx pip install -e certbot-nginx
nosetests -v certbot_nginx nosetests -v certbot_nginx
pip install -e letshelp-letsencrypt pip install -e letshelp-certbot
nosetests -v letshelp_letsencrypt nosetests -v letshelp_certbot
setenv = setenv =
PYTHONPATH = {toxinidir} PYTHONPATH = {toxinidir}
@@ -54,7 +54,7 @@ commands =
[testenv:cover] [testenv:cover]
basepython = python2.7 basepython = python2.7
commands = commands =
pip install -e acme[dev] -e .[dev] -e certbot-apache -e certbot-nginx -e letshelp-letsencrypt pip install -e acme[dev] -e .[dev] -e certbot-apache -e certbot-nginx -e letshelp-certbot
./tox.cover.sh ./tox.cover.sh
[testenv:lint] [testenv:lint]
@@ -64,19 +64,19 @@ basepython = python2.7
# duplicate code checking; if one of the commands fails, others will # duplicate code checking; if one of the commands fails, others will
# continue, but tox return code will reflect previous error # continue, but tox return code will reflect previous error
commands = commands =
pip install -e acme[dev] -e .[dev] -e certbot-apache -e certbot-nginx -e certbot-compatibility-test -e letshelp-letsencrypt pip install -e acme[dev] -e .[dev] -e certbot-apache -e certbot-nginx -e certbot-compatibility-test -e letshelp-certbot
./pep8.travis.sh ./pep8.travis.sh
pylint --rcfile=.pylintrc certbot pylint --rcfile=.pylintrc certbot
pylint --rcfile=acme/.pylintrc acme/acme pylint --rcfile=acme/.pylintrc acme/acme
pylint --rcfile=.pylintrc certbot-apache/certbot_apache pylint --rcfile=.pylintrc certbot-apache/certbot_apache
pylint --rcfile=.pylintrc certbot-nginx/certbot_nginx pylint --rcfile=.pylintrc certbot-nginx/certbot_nginx
pylint --rcfile=.pylintrc certbot-compatibility-test/certbot_compatibility_test pylint --rcfile=.pylintrc certbot-compatibility-test/certbot_compatibility_test
pylint --rcfile=.pylintrc letshelp-letsencrypt/letshelp_letsencrypt pylint --rcfile=.pylintrc letshelp-certbot/letshelp_certbot
[testenv:apacheconftest] [testenv:apacheconftest]
#basepython = python2.7 #basepython = python2.7
commands = commands =
pip install -e acme -e .[dev] -e certbot-apache -e certbot-nginx -e certbot-compatibility-test -e letshelp-letsencrypt pip install -e acme -e .[dev] -e certbot-apache -e certbot-nginx -e certbot-compatibility-test -e letshelp-certbot
{toxinidir}/certbot-apache/certbot_apache/tests/apache-conf-files/apache-conf-test --debian-modules {toxinidir}/certbot-apache/certbot_apache/tests/apache-conf-files/apache-conf-test --debian-modules