✨ add to_markdown to Series

Author: Marco Gorelli

pandas/core/series.py

@@ -1434,6 +1434,28 @@ def to_string(
                 with open(buf, "w") as f:
                     f.write(result)
 
+    def to_markdown(self, **kwargs):
+        """
+        Print a Series in markdown-friendly format.
+
+        .. versionadded:: 1.0
+
+        Returns
+        -------
+        str
+            Series in markdown-friendly format.
+
+        Examples
+        --------
+        >>> s = pd.Series([1, 2, 3, 4])
+        >>> print(s.to_markdown())
+        |    |   col1 |   col2 |
+        |---:|-------:|-------:|
+        |  0 |      1 |      3 |
+        |  1 |      2 |      4 |
+        """
+        return self.to_frame().to_markdown(**kwargs)
+
     # ----------------------------------------------------------------------
 
     def items(self):

pandas/tests/io/formats/test_to_markdown.py

@@ -5,15 +5,31 @@
 
 @td.skip_if_no_tabulate
 class TestToMarkdown:
-    def test_to_markdown(self):
+    def test_simple(self):
         df = pd.DataFrame([1, 2, 3])
         result = df.to_markdown()
         assert (
             result
             == "|    |   0 |\n|---:|----:|\n|  0 |   1 |\n|  1 |   2 |\n|  2 |   3 |"
         )
 
-    def test_to_markdown_other_tablefmt(self):
+    def test_other_tablefmt(self):
         df = pd.DataFrame([1, 2, 3])
         result = df.to_markdown(tablefmt="jira")
         assert result == "||    ||   0 ||\n|  0 |   1 |\n|  1 |   2 |\n|  2 |   3 |"
+
+    def test_other_headers(self):
+        df = pd.DataFrame([1, 2, 3])
+        result = df.to_markdown(headers=["foo", "bar"])
+        assert (
+            result
+            == "|   foo |   bar |\n|------:|------:|\n|     0 |     1 |\n|     1 |     2 |\n|     2 |     3 |"
+        )
+
+    def test_series(self):
+        s = pd.Series([1, 2, 3], name="foo")
+        result = s.to_markdown()
+        assert (
+            result
+            == "|    |   foo |\n|---:|------:|\n|  0 |     1 |\n|  1 |     2 |\n|  2 |     3 |"
+        )