dcppc · charlesreid1 · Sep 15, 2018 · Sep 15, 2018 · Sep 15, 2018 · Sep 15, 2018
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,125 @@
+# ignore uncle archie config file
+config.py
+
+# ignore virtualenv
+vp
+
 .htpasswd
 __pycache__
 site/
 config.json
-vp
+
+# mkdocs
+site/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
diff --git a/LICENSE b/LICENSE
@@ -1,41 +1,29 @@
 Copyright (c) 2018 Charles Reid
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+BSD 3-Clause License:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
 
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
 
--------------------------------------
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
 
-Original license of carlos-jenkins/python-github-webhooks on github:
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
- https://github.com/carlos-jenkins/python-github-webhooks.git
-
-Copyright (C) 2014, 2015, 2016 Carlos Jenkins <carlos@jenkins.co.cr>
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-  http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied.  See the License for the
-specific language governing permissions and limitations
-under the License.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,4 @@
+graft src/webapp/templates
+graft src/webapp/static
+graft src/tests/payloads
+
diff --git a/Readme.md b/Readme.md
@@ -27,9 +27,12 @@ Source code mirror: <https://github.com/charlesreid1/uncle-archie>
 
 ## Quick Start
 
+**(Unless otherwise noted, the following commands should be
+executed from the command line.)**
+
 To get started, run the Uncle Archie Flask server:
 
-```
+```bash
 python uncle_archie.py
 ```
 
@@ -41,7 +44,9 @@ define a custom function that takes the payload, a dictionary
 of meta-info (repo, branch name, and action name), and the 
 configuration dictionary:
 
-```
+(The following is Python code)
+
+```python
 def process_payload(payload, meta, config):
     # Do some stuff here, 
     # like use the payload to see
@@ -53,7 +58,7 @@ def process_payload(payload, meta, config):
 
 Put this in a Python file in the the `hooks/` directory:
 
-```
+```bash
 cat > hooks/my_cool_hook.py <<EOF
 def process_payload(payload, meta, config):
     # Do some stuff here, 
@@ -68,10 +73,13 @@ EOF
 Now edit `process_payload.py` in the repo so that it loads
 this new hook:
 
-```
+(The following is Python code)
+
+```python
 # ...
 # other import statements
 # ...
+
 from hooks.my_cool_hook import process_payload as my_cool_hook
 
 def process_payload(payload,meta,config):

diff --git a/attic/configuring.md b/attic/configuring.md
diff --git a/attic/css/custom.css b/attic/css/custom.css
diff --git a/attic/ghprb.md b/attic/ghprb.md
diff --git a/attic/images/jenkins-configure-location.png b/attic/images/jenkins-configure-location.png
diff --git a/attic/images/jenkins-configure.png b/attic/images/jenkins-configure.png
diff --git a/attic/images/jenkins-ghprb-1.png b/attic/images/jenkins-ghprb-1.png
diff --git a/attic/images/jenkins-ghprb-2.png b/attic/images/jenkins-ghprb-2.png
diff --git a/attic/images/jenkins-ghprb-3.png b/attic/images/jenkins-ghprb-3.png
diff --git a/attic/images/jenkins-ghprb-4.png b/attic/images/jenkins-ghprb-4.png
diff --git a/attic/images/jenkins-ghprb-5-test-1.png b/attic/images/jenkins-ghprb-5-test-1.png
diff --git a/attic/images/jenkins-ghprb-5-test-2.png b/attic/images/jenkins-ghprb-5-test-2.png
diff --git a/attic/images/jenkins-ghprb-5-test-3.png b/attic/images/jenkins-ghprb-5-test-3.png
diff --git a/attic/images/jenkins-ghprb-5-test-4.png b/attic/images/jenkins-ghprb-5-test-4.png
diff --git a/attic/images/jenkins-ghprb-5-test-5.png b/attic/images/jenkins-ghprb-5-test-5.png
diff --git a/attic/images/jenkins-ghprb-5-test-6.png b/attic/images/jenkins-ghprb-5-test-6.png
diff --git a/attic/images/jenkins-ghprb-5-test-7.png b/attic/images/jenkins-ghprb-5-test-7.png
diff --git a/attic/images/jenkins-ghprb-6-config-1.png b/attic/images/jenkins-ghprb-6-config-1.png
diff --git a/attic/images/jenkins-ghprb-6-config-2.png b/attic/images/jenkins-ghprb-6-config-2.png
diff --git a/attic/images/jenkins-installing-1.png b/attic/images/jenkins-installing-1.png
diff --git a/attic/images/jenkins-installing-2.png b/attic/images/jenkins-installing-2.png
diff --git a/attic/images/jenkins-installing-3.png b/attic/images/jenkins-installing-3.png
diff --git a/attic/images/jenkins-job-1.png b/attic/images/jenkins-job-1.png
diff --git a/attic/images/jenkins-job-2.png b/attic/images/jenkins-job-2.png
diff --git a/attic/images/jenkins-job-3.png b/attic/images/jenkins-job-3.png
diff --git a/attic/images/jenkins-job-4.png b/attic/images/jenkins-job-4.png
diff --git a/attic/images/jenkins-job-5.png b/attic/images/jenkins-job-5.png
diff --git a/attic/images/jenkins-login-post.png b/attic/images/jenkins-login-post.png
diff --git a/attic/images/jenkins-login-pre.png b/attic/images/jenkins-login-pre.png
diff --git a/attic/images/jenkins-manage-2.png b/attic/images/jenkins-manage-2.png
diff --git a/attic/images/jenkins-manage.png b/attic/images/jenkins-manage.png
diff --git a/attic/images/jenkins-pm-avail.png b/attic/images/jenkins-pm-avail.png
diff --git a/attic/images/jenkins-pm-inst-2.png b/attic/images/jenkins-pm-inst-2.png
diff --git a/attic/images/jenkins-pm-inst.png b/attic/images/jenkins-pm-inst.png
diff --git a/attic/images/jenkins-pm.png b/attic/images/jenkins-pm.png
diff --git a/attic/images/jenkins-running-1.png b/attic/images/jenkins-running-1.png
diff --git a/attic/images/jenkins-running-2.png b/attic/images/jenkins-running-2.png
diff --git a/attic/images/jenkins-running-3.png b/attic/images/jenkins-running-3.png
diff --git a/attic/index.md b/attic/index.md