Small formatting fixes (#120)

* remove noqa; rebuild docs

* add black check

* rerun used updated black

Author: ejm714

Makefile

@@ -28,6 +28,7 @@ test: lint
 	pytest -vv
 
 lint:
+	black --check deon tests docs
 	flake8 .
 
 ## Run tests and build rendered examples and docs

deon/__main__.py

@@ -1,4 +1,4 @@
 from .cli import main
 
 if __name__ == "__main__":
-    main(prog_name='python -m deon')
+    main(prog_name="python -m deon")

deon/formats.py

@@ -6,16 +6,16 @@
 
 # File types
 class Format(object):
-    """ Template for a specific file type; renders and
-        writes out to file.
+    """Template for a specific file type; renders and
+    writes out to file.
 
-        For text formats, simply override the templates
-        below. For other formats, override `render`
-        and `write`.
+    For text formats, simply override the templates
+    below. For other formats, override `render`
+    and `write`.
 
-        `render` should return an object whose string
-        representation is a fully valid document of
-        that format.
+    `render` should return an object whose string
+    representation is a fully valid document of
+    that format.
     """
 
     template = "{title}\n\n{sections}\n\n{docs_link}"
@@ -33,8 +33,8 @@ def __init__(self, checklist):
         self.checklist = checklist
 
     def render(self):
-        """ Uses the checklist and templates to render
-            all of the components for this format.
+        """Uses the checklist and templates to render
+        all of the components for this format.
         """
         rendered_sections = []
         for section in self.checklist.sections:
@@ -60,14 +60,14 @@ def render(self):
             sections=all_sections,
             docs_link=self.docs_link,
             badge=self.badge,
-        )  # noqa: E501
+        )
 
     def write(self, filepath, overwrite=False):
-        """ Renders template and writes to `filepath`.
+        """Renders template and writes to `filepath`.
 
-            If `overwrite=True`, write over anything at
-            `filepath`. Else, if the file exists append to
-            the end of file.
+        If `overwrite=True`, write over anything at
+        `filepath`. Else, if the file exists append to
+        the end of file.
         """
         filepath = Path(filepath)
 
@@ -82,8 +82,7 @@ def write(self, filepath, overwrite=False):
 
 
 class Markdown(Format):
-    """ Markdown template items
-    """
+    """Markdown template items"""
 
     template = "# {title}\n{badge}\n{sections}\n\n{docs_link}"
     section_template = """## {title}
@@ -95,12 +94,11 @@ class Markdown(Format):
     )
     badge = """
 [![Deon badge](https://img.shields.io/badge/ethics%20checklist-deon-brightgreen.svg?style=popout-square)](http://deon.drivendata.org/)
-"""  # noqa: E501
+"""
 
 
 class Rst(Format):
-    """reStructuredText template items
-    """
+    """reStructuredText template items"""
 
     template = "{title}\n============\n\n{badge}\n\n{sections}\n\n{docs_link}"
     section_template = """{title}\n---------\n\n{lines}"""
@@ -123,14 +121,13 @@ def __repr__(self):
 
 
 class JupyterNotebook(Markdown):
-    """ Jupyter notebook template items
-    """
+    """Jupyter notebook template items"""
 
     append_delimiter = {"cell_type": "markdown", "metadata": {}, "source": ["-----\n"]}
 
     def render(self):
-        """ Creates json for a valid blank Jupyter notebook with a cell
-            containing the rendered Markdown of the checklist.
+        """Creates json for a valid blank Jupyter notebook with a cell
+        containing the rendered Markdown of the checklist.
         """
         text = super().render()
 
@@ -150,9 +147,9 @@ def render(self):
         return JsonDict(blank_jupyter_notebook)
 
     def write(self, filepath, overwrite=False):
-        """ If notebook does not exist (or `overwrite=True`), write new
-            notebook with checklist. Otherwise append a cell with a
-            horizontal rule and another cell with the checklist.
+        """If notebook does not exist (or `overwrite=True`), write new
+        notebook with checklist. Otherwise append a cell with a
+        horizontal rule and another cell with the checklist.
         """
         nbdata = self.render()
 
@@ -171,8 +168,7 @@ def write(self, filepath, overwrite=False):
 
 
 class JupyterNotebookMulticell(JupyterNotebook):
-    """ Jupyter notebook multiple cell format
-    """
+    """Jupyter notebook multiple cell format"""
 
     def render(self):
         text = super(JupyterNotebook, self).render()
@@ -232,18 +228,18 @@ class Html(Format):
 """
 
     def render(self):
-        """ Create a new blank HTML document with checklist as the body.
-            Returned as a BeautifulSoup object.
+        """Create a new blank HTML document with checklist as the body.
+        Returned as a BeautifulSoup object.
         """
         rendered_html = self.doc_template.format(text=super().render())
         soup = BeautifulSoup(rendered_html, "html.parser")
         # string representation of soup is the raw html, so we can return it
         return soup
 
     def write(self, filepath, overwrite=False):
-        """ If html document does not exist (or `overwrite=True`), write new
-            html file with checklist. Otherwise append checklist to the end of
-            the body of the existing html file.
+        """If html document does not exist (or `overwrite=True`), write new
+        html file with checklist. Otherwise append checklist to the end of
+        the body of the existing html file.
         """
         filepath = Path(filepath)
 

deon/parser.py

@@ -2,8 +2,7 @@
 
 
 class Checklist(object):
-    """ Stores a checklist data parsed from a yaml file.
-    """
+    """Stores a checklist data parsed from a yaml file."""
 
     def __init__(self, title, sections):
         self.title = title
@@ -27,8 +26,8 @@ def read(cls, filepath):
 
 
 class Section(object):
-    """ Stores the sections of the checklist that are read in
-        from a file.
+    """Stores the sections of the checklist that are read in
+    from a file.
     """
 
     def __init__(self, title, section_id, lines):

docs/render_templates.py

@@ -10,7 +10,9 @@
 from deon.parser import Checklist
 
 
-env = Environment(loader=FileSystemLoader("md_templates"),)
+env = Environment(
+    loader=FileSystemLoader("md_templates"),
+)
 
 TEMPLATE_AND_OUTPUT = {
     "index.tpl": Path("docs/index.md"),

tests/assets.py

@@ -24,7 +24,7 @@
  - [ ] **B.1 B1sum**: First B line
  - [ ] **B.2 B2sum**: Second B line
 
-*Data Science Ethics Checklist generated with [deon](http://deon.drivendata.org).*"""  # noqa: E501
+*Data Science Ethics Checklist generated with [deon](http://deon.drivendata.org).*"""
 
 known_good_rst = """My Checklist
 ============
@@ -57,7 +57,7 @@
             "source": [
                 "# My Checklist\n",
                 "\n",
-                "[![Deon badge](https://img.shields.io/badge/ethics%20checklist-deon-brightgreen.svg?style=popout-square)](http://deon.drivendata.org/)\n",  # noqa: E501
+                "[![Deon badge](https://img.shields.io/badge/ethics%20checklist-deon-brightgreen.svg?style=popout-square)](http://deon.drivendata.org/)\n",
                 "\n",
                 "## A. First section\n",
                 " - [ ] **A.1 A1sum**: First A line\n",
@@ -84,7 +84,7 @@
             "cell_type": "markdown",
             "metadata": {},
             "source": [
-                "[![Deon badge](https://img.shields.io/badge/ethics%20checklist-deon-brightgreen.svg?style=popout-square)](http://deon.drivendata.org/)",  # noqa: E501
+                "[![Deon badge](https://img.shields.io/badge/ethics%20checklist-deon-brightgreen.svg?style=popout-square)](http://deon.drivendata.org/)",
             ],
         },
         {"cell_type": "markdown", "metadata": {}, "source": ["## A. First section"]},
@@ -182,7 +182,7 @@
   </em>
  </body>
 </html>
-"""  # noqa: E501
+"""
 
 existing_text_html = """<html>
 <body>
@@ -255,4 +255,4 @@
   </em>
  </body>
 </html>
-"""  # noqa: E501
+"""