Merge pull request #142 from rstudio/feat-rsc-code-block

Feat rsc code block
rstudio · Jun 24, 2022 · 8915c12 · 8915c12
2 parents 4acf0b8 + 3b5e78c
commit 8915c12
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 16 deletions.
diff --git a/pins/boards.py b/pins/boards.py
@@ -905,6 +905,8 @@ def user_name(self):
             return self._user_name
 
     def prepare_pin_version(self, pin_dir_path, x, name: "str | None", *args, **kwargs):
+        # TODO: should move board_deparse into utils, to avoid circular import
+        from .constructors import board_deparse
 
         # RSC pin names can have form <user_name>/<name>, but this will try to
         # create the object in a directory named <user_name>. So we grab just
@@ -939,6 +941,7 @@ def prepare_pin_version(self, pin_dir_path, x, name: "str | None", *args, **kwar
             "pin_name": self.path_to_pin(name),
             "pin_files": pin_files,
             "pin_metadata": meta,
+            "board_deparse": board_deparse(self),
         }
 
         # data preview ----

diff --git a/pins/rsconnect/html/index.html b/pins/rsconnect/html/index.html
@@ -49,16 +49,12 @@ <h3>{{pin_name}}</h3>
     <section>
     <h3>Code</h3>
 
-    <!-- TODO: how to handle this?
-
-      <pre id="pin-r" class="pin-code"><code class="r">library(pins)
-board <- {{board_deparse}}
-pin_read(board, "{{pin_name}}")</code></pre>
-
-    !-->
+    <pre id="pin-python" class="pin-code"><code class="python">from pins import board_rsconnect
+board = {{board_deparse}}
+board.pin_read("{{pin_name}}")</code></pre>
 
     <script type="text/javascript">
-      hljs.registerLanguage("r", highlight_r);
+      hljs.registerLanguage("python", highlight_python);
       hljs.initHighlightingOnLoad();
     </script>
     </section>

diff --git a/pins/tests/_snapshots/test_board_pin_write_rsc_index_html/index.html b/pins/tests/_snapshots/test_board_pin_write_rsc_index_html/index.html
@@ -58,16 +58,12 @@ <h3>derek/test_rsc_pin</h3>
     <section>
     <h3>Code</h3>
 
-    <!-- TODO: how to handle this?
-
-      <pre id="pin-r" class="pin-code"><code class="r">library(pins)
-board <- 
-pin_read(board, "derek/test_rsc_pin")</code></pre>
-
-    !-->
+    <pre id="pin-python" class="pin-code"><code class="python">from pins import board_rsconnect
+board = board_rsconnect(server_url='http://localhost:3939')
+board.pin_read("derek/test_rsc_pin")</code></pre>
 
     <script type="text/javascript">
-      hljs.registerLanguage("r", highlight_r);
+      hljs.registerLanguage("python", highlight_python);
       hljs.initHighlightingOnLoad();
     </script>
     </section>