dp_wizard_templates 0.1.0__py2.py3-none-any.whl → 0.2.0__py2.py3-none-any.whl

dp_wizard_templates/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

dp_wizard_templates/code_template.py

@@ -1,9 +1,9 @@
+import inspect
 import re
+import black
 
 
 def _get_body(func):
-    import inspect
-    import re
 
     source_lines = inspect.getsource(func).splitlines()
     first_line = source_lines[0]
@@ -116,7 +116,7 @@ class Template:
                 raise Exception(base_message)
         return self
 
-    def finish(self) -> str:
+    def finish(self, reformat=False) -> str:
         unfilled_slots = self._initial_slots & self._find_slots()
         if unfilled_slots:
             slots_str = ", ".join(sorted(f"'{slot}'" for slot in unfilled_slots))
@@ -124,4 +124,8 @@ class Template:
                 f"{slots_str} slot not filled "
                 f"in {self._source}:\n\n{self._template}"
             )
+
+        if reformat:
+            self._template = black.format_str(self._template, mode=black.Mode())
+
         return self._template

dp_wizard_templates/converters.py

@@ -7,6 +7,7 @@ import json
 import nbformat
 import nbconvert
 import jupytext
+import black
 
 
 def _is_kernel_installed() -> bool:
@@ -27,7 +28,9 @@ class ConversionException(Exception):
         return f"Script to notebook conversion failed: {self.command}\n{self.stderr})"
 
 
-def convert_py_to_nb(python_str: str, title: str, execute: bool = False):
+def convert_py_to_nb(
+    python_str: str, title: str, execute: bool = False, reformat: bool = True
+):
     """
     Given Python code as a string, returns a notebook as a string.
     Calls jupytext as a subprocess:
@@ -43,6 +46,9 @@ def convert_py_to_nb(python_str: str, title: str, execute: bool = False):
 
         temp_dir_path = Path(temp_dir)
         py_path = temp_dir_path / "input.py"
+        if reformat:
+            # Line length determined by PDF rendering.
+            python_str = black.format_str(python_str, mode=black.Mode(line_length=74))
         py_path.write_text(python_str)
 
         argv = [executable] + "-m jupytext --from .py --to .ipynb --output -".split(" ")
@@ -82,7 +88,9 @@ def _clean_nb(nb_json: str):
     for cell in nb["cells"]:
         if "pip install" in cell["source"][0]:
             cell["outputs"] = []
-        if "# Coda\n" in cell["source"]:
+        # "Coda" may, or may not be followed by "\n".
+        # Be flexible!
+        if any(line.startswith("# Coda") for line in cell["source"]):
             break
         # Make ID stable:
         cell["id"] = _stable_hash(cell["source"])
@@ -96,13 +104,9 @@ def _clean_nb(nb_json: str):
     return json.dumps(nb, indent=1)
 
 
-def convert_nb_to_html(python_nb: str):
-    return _convert_nb(python_nb, nbconvert.HTMLExporter)
-
-
-def _convert_nb(python_nb: str, exporter_constructor):
+def convert_nb_to_html(python_nb: str, numbered=True):
     notebook = nbformat.reads(python_nb, as_version=4)
-    exporter = exporter_constructor(
+    exporter = nbconvert.HTMLExporter(
         template_name="lab",
         # The "classic" template's CSS forces large code cells on to
         # the next page rather than breaking, so use "lab" instead.
@@ -116,4 +120,13 @@ def _convert_nb(python_nb: str, exporter_constructor):
         # ],
     )
     (body, _resources) = exporter.from_notebook_node(notebook)
+    if not numbered:
+        body = body.replace(
+            "</head>",
+            """
+<style>
+.jp-InputPrompt {display: none;}
+</style>
+</head>""",
+        )
     return body

{dp_wizard_templates-0.1.0.dist-info → dp_wizard_templates-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dp_wizard_templates
-Version: 0.1.0
+Version: 0.2.0
 Summary: Code templating tools
 Author-email: The OpenDP Project <info@opendp.org>
 Description-Content-Type: text/markdown
@@ -10,7 +10,8 @@ Requires-Dist: ipykernel
 Requires-Dist: jupyter-client
 Requires-Dist: jupytext
 Requires-Dist: nbconvert
-Project-URL: Home, https://github.com/opendp/dp-wizard-templates
+Project-URL: GitHub, https://github.com/opendp/dp-wizard-templates
+Project-URL: Homepage, https://opendp.github.io/dp-wizard-templates
 
 # DP Wizard Templates
 
@@ -19,12 +20,7 @@ Project-URL: Home, https://github.com/opendp/dp-wizard-templates
 DP Wizard Templates lets you use syntactically valid Python code as a template.
 Templates can be filled and composed to generate entire notebooks.
 
-[`README_test.py`](https://github.com/opendp/dp-wizard-templates/blob/main/README_test.py) provides an example of use,
-and an example [output notebook](https://github.com/opendp/dp-wizard-templates/blob/main/README_examples/hello-world.ipynb)
-is also available.
-
-DP Wizard Templates was developed for [DP Wizard](https://github.com/opendp/dp-wizard),
-and that codebase remains a good place to look for further examples.
+See the [documentation](https://opendp.github.io/dp-wizard-templates) for more information.
 
 
 ## Development

dp_wizard_templates-0.2.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+dp_wizard_templates/VERSION,sha256=kR_AxIywxwYB21d1qb7xt0DcTMn5tGOJufBWP-frlNc,5
+dp_wizard_templates/__init__.py,sha256=E2xrnvZGY24pU3PCryH4TmvhNYsLmxXCtfvIcYNbTYw,126
+dp_wizard_templates/code_template.py,sha256=HwnmKmJStkan9jkdyRQ4zVnJcvHWymzzCt8lwdTdtX4,4504
+dp_wizard_templates/converters.py,sha256=voLc2KlJ7WZGYMtA8x0pB1xBcLJs974uoX2nCJO7uD0,4331
+dp_wizard_templates-0.2.0.dist-info/licenses/LICENSE,sha256=FDrIMeZPiT4g_4w0i1Ec4Bc8h9wfNytroheQN4508yU,1063
+dp_wizard_templates-0.2.0.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
+dp_wizard_templates-0.2.0.dist-info/METADATA,sha256=zvMOoJELX1KP5e_3gIcimNjp62lDNyOd7BfkGahvdLg,1881
+dp_wizard_templates-0.2.0.dist-info/RECORD,,

dp_wizard_templates-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-dp_wizard_templates/VERSION,sha256=atlhOkVXmNbZLl9fOQq0uqcFlryGntaxf1zdKyhjXwY,5
-dp_wizard_templates/__init__.py,sha256=E2xrnvZGY24pU3PCryH4TmvhNYsLmxXCtfvIcYNbTYw,126
-dp_wizard_templates/code_template.py,sha256=GW4wcAguGRFEE_eKLPedjmsklZR9dtx4wn8CYq-avh8,4389
-dp_wizard_templates/converters.py,sha256=l-MYAiTAH_isjggH03DKlgV-j-uxc0CyW1hiCLD39yQ,3957
-dp_wizard_templates-0.1.0.dist-info/licenses/LICENSE,sha256=FDrIMeZPiT4g_4w0i1Ec4Bc8h9wfNytroheQN4508yU,1063
-dp_wizard_templates-0.1.0.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
-dp_wizard_templates-0.1.0.dist-info/METADATA,sha256=ZMvavNpdRK7GvyB-j4ht2JWSzPjhIC52n7VHVCyX70c,2139
-dp_wizard_templates-0.1.0.dist-info/RECORD,,