Merge pull request #70 from dexplo/develop

Develop

Author: mjam03

README.md

@@ -114,7 +114,8 @@ jtm.publish('My Awesome Jupyter Notebook.ipynb',
             save_markdown=False,
             table_conversion='chrome',
             gistify=False,
-            gist_threshold=5
+            gist_threshold=5,
+            public_gists=True
             )
 ```
 

docs/index.md

@@ -133,7 +133,8 @@ jtm.publish('My Awesome Jupyter Notebook.ipynb',
             save_markdown=False,
             table_conversion='chrome',
             gistify=False,
-            gist_threshold=5
+            gist_threshold=5,
+            public_gists=True
             )
 ```
 

docs/requirements.txt

@@ -1,5 +1,5 @@
 markdown-include==0.6.0
-mkdocs==1.2.3
+mkdocs==1.2.4
 mkdocs-autolinks-plugin==0.4.0
 mkdocs-autorefs==0.3.0
 mkdocs-git-revision-date-localized-plugin==0.10.1

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "jupyter-to-medium"
-version = "0.2.11"
+version = "0.2.12"
 description = "Publish a Jupyter Notebook as a Medium blogpost"
 authors = ["dexplo <[email protected]>"]
 maintainers = ["mjam03 <[email protected]>"]
@@ -40,6 +40,10 @@ nox = "^2021.10.1"
 nox-poetry = "^0.9.0"
 
 # let pytest coverage know where code is
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.1.1"
+
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]
 

pyproject.toml

@@ -8,6 +8,14 @@
 
 
 def _jupyter_bundlerextension_paths():
+    """Function used to install extension when the following is called on comand line:
+    jupyter bundlerextension enable --py jupyter_to_medium._bundler --sys-prefix
+    Jupyter docs here:
+    https://jupyter-notebook.readthedocs.io/en/stable/extending/bundler_extensions.html#enabling-disabling-bundler-extensions
+
+    Returns:
+        list: config needed to install extension
+    """
     return [
         {
             # the name of the bundle
@@ -37,18 +45,20 @@ def upload(model, handler):
         "table_conversion",
         "gistify",
         "gist_threshold",
+        "public_gists"
     ]
 
     kwargs = {arg: handler.get_query_argument(arg, None) for arg in arguments}
     path = model["path"]
     kwargs["filename"] = path
     kwargs["integration_token"] = kwargs["integration_token"].strip() or None
-    kwargs["pub_name"] == kwargs["pub_name"].strip() or None
+    kwargs["pub_name"] = kwargs["pub_name"].strip() or None
     kwargs["tags"] = [tag.strip() for tag in kwargs["tags"].split(",")[:5]]
     kwargs["notify_followers"] = kwargs["notify_followers"] == "True"
     kwargs["canonical_url"] = kwargs["canonical_url"].strip() or None
     kwargs["save_markdown"] = kwargs["save_markdown"] == "True"
     kwargs["gistify"] = kwargs["gistify"] == "True"
+    kwargs["public_gists"] = kwargs["public_gists"] == "True"
     if kwargs["gist_threshold"] == "":
         kwargs["gist_threshold"] = 5
     else:
@@ -85,7 +95,7 @@ def upload(model, handler):
 def read_html(name):
     mod_path = Path(__file__).parent
     html_path = mod_path / "static" / f"{name}.html"
-    return open(html_path).read()
+    return open(html_path, encoding="utf-8").read()
 
 
 def get_html_form(xsrf_input, title):

src/jupyter_to_medium/_bundler.py

@@ -106,10 +106,14 @@ class CustomFormatter(argparse.RawTextHelpFormatter):
     generate a Personal Access Token (PAT) on github that is then used,
     similar to the Medium Integration Token, to create the gists.
 
---gist_threshold
+--gist-threshold
     If chosen to use gists for code blocks, this sets the length in lines of
     code for which to make code blocks into gists. This is to prevent gists of
     only several lines unless desired.
+    
+--public-gists
+    Whether to create the gists as public (can be found by search engines)
+    or private (only accessible through link).
 
 Examples
 ========
@@ -120,18 +124,14 @@ class CustomFormatter(argparse.RawTextHelpFormatter):
 
 """
 
-parser = argparse.ArgumentParser(
-    formatter_class=CustomFormatter, add_help=False, usage=argparse.SUPPRESS
-)
+parser = argparse.ArgumentParser(formatter_class=CustomFormatter, add_help=False, usage=argparse.SUPPRESS)
 parser.add_argument("filename", default=False)
 parser.add_argument("-h", "--help", action="store_true", dest="help")
 parser.add_argument("--integration-token", type=str)
 parser.add_argument("--pub-name", type=str)
 parser.add_argument("--title", type=str)
 parser.add_argument("--tags", type=str)
-parser.add_argument(
-    "--publish-status", type=str, choices=["draft"], default="draft"
-)
+parser.add_argument("--publish-status", type=str, choices=["draft"], default="draft")
 parser.add_argument("--notify-followers", type=bool, default=False)
 parser.add_argument(
     "--license",
@@ -160,6 +160,7 @@ class CustomFormatter(argparse.RawTextHelpFormatter):
 )
 parser.add_argument("--gistify", type=bool, default=False)
 parser.add_argument("--gist-threshold", type=int, default=5)
+parser.add_argument("--public-gists", type=bool, default=False)
 
 
 def main():

src/jupyter_to_medium/_command_line.py

@@ -30,8 +30,7 @@ def is_latex_cell(cell):
 
 
 def render_latex(formula, fontsize=10, dpi=200, format_="png"):
-    """Renders LaTeX formula into image.
-    """
+    """Renders LaTeX formula into image."""
     # set formatting
     mpl_context = {
         "text.usetex": False,
@@ -43,7 +42,7 @@ def render_latex(formula, fontsize=10, dpi=200, format_="png"):
     # use formatting and make text figure
     with plt.style.context(mpl_context):
         fig = plt.figure(figsize=(0.01, 0.01))
-        fig.text(0, 0, u"${}$".format(formula), fontsize=fontsize)
+        fig.text(0, 0, f"${formula}$", fontsize=fontsize)
     # create bytes buffer
     buffer_ = StringIO()
     # save fig to buffer and close it
@@ -158,13 +157,13 @@ def format_multiline_latex(latex: list) -> str:
 def format_latex(latex: str) -> str:
 
     # seperate handling for one liners vs multi-liners
-    latex = latex.split("\n")
-    if len(latex) == 1:
+    latex_list = latex.split("\n")
+    if len(latex_list) == 1:
         # then we have a 1 liner
-        lt = format_single_line_latex(latex[0])
+        lt = format_single_line_latex(latex_list[0])
     else:
         # else multiline statement
-        lt = format_multiline_latex(latex)
+        lt = format_multiline_latex(latex_list)
     return lt
 
 

src/jupyter_to_medium/_latex.py

@@ -37,7 +37,7 @@ def parse_html(self, html):
         num_cols = sum(val[-1] for val in rows[0])
         new_rows = []
         rowspan = {}
-        for i, row in enumerate(rows):
+        for _, row in enumerate(rows):
             new_row = []
             col_loc = 0
             j = 0
@@ -123,9 +123,7 @@ def get_all_text_widths(self, rows):
             for vals in row:
                 cell_max_width = 0
                 for text in vals[0].split("\n"):
-                    cell_max_width = max(
-                        cell_max_width, self.get_text_width(text)
-                    )
+                    cell_max_width = max(cell_max_width, self.get_text_width(text))
                 row_widths.append(cell_max_width)
             all_text_widths.append(row_widths)
         return np.array(all_text_widths) + 15
@@ -162,14 +160,12 @@ def wrap_col(self, idx, col_widths, mult):
         texts = [row[idx][0] for row in self.rows]
         new_texts = []
         new_max_width = 0
-        for i, (text, col_width) in enumerate(zip(texts, col_widths)):
+        for _, (text, col_width) in enumerate(zip(texts, col_widths)):
             if col_width > mult * max_width and len(text) > self.wrap_length:
                 width = max(self.wrap_length, int(len(text) * mult))
                 new_text = textwrap.fill(text, width, break_long_words=False)
                 new_texts.append(new_text)
-                new_max_width = max(
-                    new_max_width, self.get_text_width(new_text)
-                )
+                new_max_width = max(new_max_width, self.get_text_width(new_text))
             else:
                 new_texts.append(text)
 
@@ -243,12 +239,10 @@ def print_table(self):
                 self.fig.add_artist(p)
 
             if i == self.num_header_rows - 1:
-                line = mlines.Line2D(
-                    [x0, x0 + total_width], [y, y], color="black"
-                )
+                line = mlines.Line2D([x0, x0 + total_width], [y, y], color="black")
                 self.fig.add_artist(line)
 
-        w, h = self.fig.get_size_inches()
+        _, h = self.fig.get_size_inches()
         start = self.figwidth * min(x0, 0.1)
         end = self.figwidth - start
         bbox = Bbox([[start - 0.1, y * h], [end + 0.1, h]])