Merge pull request #6 from cisagov/improvement/merge_in_upstream_changes_from_skeleton_generic

Merge in upstream changes from skeleton-generic

Author: felddy

.flake8

@@ -3,6 +3,8 @@ max-line-length = 80
 # Select (turn on)
 # * Complexity violations reported by mccabe (C) -
 #   http://flake8.pycqa.org/en/latest/user/error-codes.html#error-violation-codes
+# * Documentation conventions compliance reported by pydocstyle (D) -
+#   http://www.pydocstyle.org/en/stable/error_codes.html
 # * Default errors and warnings reported by pycodestyle (E and W) -
 #   https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes
 # * Default errors reported by pyflakes (F) -
@@ -11,7 +13,7 @@ max-line-length = 80
 #   https://github.com/PyCQA/flake8-bugbear#list-of-warnings
 # * The B950 flake8-bugbear opinionated warning -
 #   https://github.com/PyCQA/flake8-bugbear#opinionated-warnings
-select = C,E,F,W,B,B950
+select = C,D,E,F,W,B,B950
 # Ignore flake8's default warning about maximum line length, which has
 # a hard stop at the configured value.  Instead we use
 # flake8-bugbear's B950, which allows up to 10% overage.

.pre-commit-config.yaml

@@ -42,6 +42,8 @@ repos:
     rev: 3.7.7
     hooks:
       - id: flake8
+        additional_dependencies:
+          - flake8-docstrings
   - repo: https://github.com/asottile/pyupgrade
     rev: v1.14.0
     hooks:

example/example.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-"""example is an example Python library and tool
+"""example is an example Python library and tool.
 
 Usage:
   example [--log-level=LEVEL]
@@ -20,7 +20,7 @@
 
 
 def example():
-    """A dummy function."""
+    """Print some logging messages."""
     logging.debug("This is a debug message")
     logging.info("This is an info message")
     logging.warning("This is a warning message")
@@ -29,6 +29,7 @@ def example():
 
 
 def main():
+    """Set up logging and call the example function."""
     args = docopt.docopt(__doc__, version="0.0.1")
 
     # Set up logging

setup.py

@@ -1,5 +1,5 @@
 """
-setup module for example
+This is the setup module for the example project.
 
 Based on:
 
@@ -11,6 +11,7 @@
 
 
 def readme():
+    """Read in and return the contents of the project's README.md file."""
     with open("README.md") as f:
         return f.read()