DataFrame could have a to_markdown method. #11052

petebachant · 2015-09-10T13:57:34Z

Similar to to_latex and to_html.

The text was updated successfully, but these errors were encountered:

TomAugspurger · 2015-09-10T14:32:13Z

Is there a widely agreed upon format for markdown tables? It's not in Gruber's original version, and IIRC CommonMark even punted on them.

petebachant · 2015-09-10T14:43:03Z

Good point. I'm not sure. Maybe the method could specify a flavor, e.g., GitHub or Pandoc?

TomAugspurger · 2015-09-10T14:50:27Z

I suspect that anything too complicated won't find much support here (maintaining stuff is no fun). Especially now that we have pipe. df.pipe(to_markdown) isn't much worse than df.to_markdown.

Is your usecase here to present / read the mardown, or convert it to something else? Since markdown is a superset of HTML, you may be able to get away with to_html before converting.

petebachant · 2015-09-10T15:21:51Z

My specific use case would be to create a DataFrame, copy/paste to GitHub flavored Markdown document (or GitHub issues, PRs, wikis, etc.), but still be able to read/edit it later without the HTML mess.

As an example, below is a table I copied from a Jupyter Qt console. First I printed the DataFrame to the terminal, copied/pasted here, then entered the dashes and pipes manually for the GH Markdown. Then I generated HTML with the to_html method, which doesn't render quite right here.

GitHub Markdown

Source

    | speed | Re_tip | Re_root | Re_ave | Re_D
---|--------|-------|--------|--------|--------
0 | 4.0e-01 | 5.0e+04 | 8.3e+04 | 6.6e+04 | 4.3e+05
1 | 6.0e-01 | 7.4e+04 |  1.2e+05 | 9.9e+04 | 6.4e+05
2 | 8.0e-01 | 9.9e+04 | 1.7e+05 | 1.3e+05 | 8.6e+05
3 | 1.0e+00 | 1.2e+05 |  2.1e+05 | 1.7e+05 | 1.1e+06
4 | 1.2e+00 | 1.5e+05 |  2.5e+05 | 2.0e+05 | 1.3e+0

Results

	speed	Re_tip	Re_root	Re_ave	Re_D
0	4.0e-01	5.0e+04	8.3e+04	6.6e+04	4.3e+05
1	6.0e-01	7.4e+04	1.2e+05	9.9e+04	6.4e+05
2	8.0e-01	9.9e+04	1.7e+05	1.3e+05	8.6e+05
3	1.0e+00	1.2e+05	2.1e+05	1.7e+05	1.1e+06
4	1.2e+00	1.5e+05	2.5e+05	2.0e+05	1.3e+0

Pandas HTML

Source

<table border="1" class="dataframe">\n  <thead>\n    <tr style="text-align: right;">\n      <th></th>\n      <th>speed</th>\n      <th>Re_tip</th>\n      <th>Re_root</th>\n      <th>Re_ave</th>\n      <th>Re_D</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <th>0</th>\n      <td>4.0e-01</td>\n      <td>5.0e+04</td>\n      <td>8.3e+04</td>\n      <td>6.6e+04</td>\n      <td>4.3e+05</td>\n    </tr>\n    <tr>\n      <th>1</th>\n      <td>6.0e-01</td>\n      <td>7.4e+04</td>\n      <td>1.2e+05</td>\n      <td>9.9e+04</td>\n      <td>6.4e+05</td>\n    </tr>\n    <tr>\n      <th>2</th>\n      <td>8.0e-01</td>\n      <td>9.9e+04</td>\n      <td>1.7e+05</td>\n      <td>1.3e+05</td>\n      <td>8.6e+05</td>\n    </tr>\n    <tr>\n      <th>3</th>\n      <td>1.0e+00</td>\n      <td>1.2e+05</td>\n      <td>2.1e+05</td>\n      <td>1.7e+05</td>\n      <td>1.1e+06</td>\n    </tr>\n    <tr>\n      <th>4</th>\n      <td>1.2e+00</td>\n      <td>1.5e+05</td>\n      <td>2.5e+05</td>\n      <td>2.0e+05</td>\n      <td>1.3e+06</td>\n    </tr>\n  </tbody>\n</table

Results

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

	speed	Re_tip	Re_root	Re_ave	Re_D
0	4.0e-01	5.0e+04	8.3e+04	6.6e+04	4.3e+05
1	6.0e-01	7.4e+04	1.2e+05	9.9e+04	6.4e+05
2	8.0e-01	9.9e+04	1.7e+05	1.3e+05	8.6e+05
3	1.0e+00	1.2e+05	2.1e+05	1.7e+05	1.1e+06
4	1.2e+00	1.5e+05	2.5e+05	2.0e+05	1.3e+06

hayd · 2015-09-11T17:13:08Z

One issue is what should the row headers be for MI columns/index. It seems that GH registers only the first (unless there is some syntactical trick).

For most flavors you can include html.

jankatins · 2015-11-11T14:26:15Z

As the new styler uses jinja (#10250), this shouldn't be too hard? I would also love this feature for knitpy, which is a markdown based format which is converted into all kind of formats (docx...pdf...html).

Up to now (and as workarounds...), I recommended tabulate to convert a DataFrame to markdown. There is also pandoc (e.g. via pypandoc), which can take the output of df.to_html() and convert that to markdown.

jreback · 2015-11-11T14:33:36Z

@JanSchulz yes, I could see .to_markdown() method in Styler (as better API than to put it directly in DataFrame (though could have that as well).

jankatins · 2015-11-11T16:50:21Z

IMO, on .styler it doesn't make sense, markdown unfortunately do not provide styles :-( I only mentioned .styler as it already (soft) requires jinja and that should make it easy to build a markdown representation...

IMO it should be DataFrame.to_markdown() and DataFrame._repr_markdown_()

ghost · 2015-11-27T13:55:00Z

I'd love DataFrame.to_markdown() too. I was surprised when it didn't work already.

This is a straightforward port of GH#10070 to 1d arrays.

pstjohn · 2017-10-11T21:53:52Z

Would pandas be open to adding a dependency? tabulate does exactly this and is pip installable.

from tabulate import tabulate
print(tabulate(df, headers='keys', tablefmt='pipe'))

|    |   test1 | test2   |   test3 |   test4 |    test5 |
|---:|--------:|:--------|--------:|--------:|---------:|
|  0 |     385 | apple   |     288 |     745 |  64.9352 |
|  1 |     627 | banana  |       3 |     792 | 226.955  |
|  2 |     486 | pear    |     446 |     503 | 110.454  |
|  3 |     368 | orange  |     887 |     808 | 297.62   |
|  4 |     550 | grape   |     235 |      96 | 240.324  |
|  5 |     749 | peach   |      22 |     598 | 240.642  |

	test1	test2	test3	test4	test5
0	385	apple	288	745	64.9352
1	627	banana	3	792	226.955
2	486	pear	446	503	110.454
3	368	orange	887	808	297.62
4	550	grape	235	96	240.324
5	749	peach	22	598	240.642

TomAugspurger · 2017-10-11T21:57:58Z

I'm +0 to adding it as an optional dependency, and adding a to_markdown method. In the meantime, `df.pipe(tabulate, header='keys', tablefmt='pipe')` is a workaround. I suppose it would be nice to avoid typing those keyword arguments every time :)

…

On Wed, Oct 11, 2017 at 4:53 PM, Peter St. John ***@***.***> wrote: Would pandas be open to adding a dependency? tabulate <https://pypi.python.org/pypi/tabulate> does exactly this and is pip installable. from tabulate import tabulateprint(tabulate(df, headers='keys', tablefmt='pipe')) test1 test2 test3 test4 test5 -- ------- ------- ------- ------- ------- 0 356 apple 876 510 904 1 90 banana 590 24 988 2 150 pear 652 731 792 3 399 orange 603 76 420 4 864 grape 322 703 324 5 281 peach 731 192 192 test1 test2 test3 test4 test5 0 356 apple 876 510 904 1 90 banana 590 24 988 2 150 pear 652 731 792 3 399 orange 603 76 420 4 864 grape 322 703 324 5 281 peach 731 192 192 — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#11052 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABQHItGeXDBlVw5VfDZ7zWNRVEVwnHEdks5srTj1gaJpZM4F7BTx> .

jreback · 2017-10-11T23:00:13Z

i think adding a to_markdown method which calls tabulate as a dependency would be ok

aflaxman · 2017-11-07T13:54:15Z

print(tabulate(df, headers='keys', tablefmt='pipe')) is not as pretty as pandas for multi-index, would be cool if whatever pandas lands on is.

kangwonlee · 2018-12-16T11:52:53Z

FYI : Google found this discussion for me: https://stackoverflow.com/questions/33181846/programmatically-convert-pandas-dataframe-to-markdown-table

MarcoGorelli · 2019-12-12T11:41:05Z

I'm +0 to adding it as an optional dependency, and adding a to_markdown method. In the meantime, df.pipe(tabulate, header='keys', tablefmt='pipe') is a workaround. I suppose it would be nice to avoid typing those keyword arguments every time :)

@TomAugspurger Is this all the method would have to do? If so, I'd be happy to work on a PR

jreback · 2019-12-12T11:47:58Z

i think we would likely accept a PR for something like the above

MarcoGorelli · 2019-12-19T16:43:18Z

Sure, I've submitted a simple PR.

What should this method return if there's a wide DataFrame? (or is this an enhancement that would get taken care of at a later stage?)

jreback added Output-Formatting __repr__ of pandas objects, to_string IO HTML read_html, to_html, Styler.apply, Styler.applymap labels Nov 11, 2015

jreback added this to the Someday milestone Nov 11, 2015

jankatins mentioned this issue Nov 12, 2015

Provide a template-engine based way of rendering pandas data objects #3190

Closed

TomAugspurger mentioned this issue Jan 10, 2016

to_markdown() #12009

Closed

jreback pushed a commit that referenced this issue Jan 14, 2016

MAINT: Make take_1d accept readonly buffers., #11052

5d8cbb2

This is a straightforward port of GH#10070 to 1d arrays.

TomAugspurger mentioned this issue Apr 1, 2016

how to paste tables from pandas/jupyter (html) to github (markdown)? #12767

Closed

s-celles mentioned this issue Nov 1, 2017

Styling console/terminal output #18066

Open

kangwonlee mentioned this issue Dec 16, 2018

Consider using pandas kangwonlee/reposetman#39

Open

simonjayhawkins mentioned this issue Jun 12, 2019

CLN: Implement io modules as plugins #26804

Open

TomAugspurger mentioned this issue Jun 22, 2019

Improve DataFrame.to_string() #27002

Closed

datapythonista mentioned this issue Sep 12, 2019

DEPR: Move rarely used I/O connectors to third party modules #28409

Closed

jreback mentioned this issue Dec 6, 2019

Add optional column separator character to DataFrame.to_string() #30105

Closed

MarcoGorelli mentioned this issue Dec 19, 2019

[ENH] Add to_markdown method #30350

Merged

5 tasks

jreback modified the milestones: Someday, 1.0 Dec 26, 2019

jreback closed this as completed in #30350 Dec 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DataFrame could have a to_markdown method. #11052

DataFrame could have a to_markdown method. #11052

petebachant commented Sep 10, 2015

TomAugspurger commented Sep 10, 2015

petebachant commented Sep 10, 2015

TomAugspurger commented Sep 10, 2015

petebachant commented Sep 10, 2015

hayd commented Sep 11, 2015

jankatins commented Nov 11, 2015

jreback commented Nov 11, 2015

jankatins commented Nov 11, 2015

ghost commented Nov 27, 2015

pstjohn commented Oct 11, 2017 •

edited

Loading

TomAugspurger commented Oct 11, 2017 via email

jreback commented Oct 11, 2017

aflaxman commented Nov 7, 2017

kangwonlee commented Dec 16, 2018

MarcoGorelli commented Dec 12, 2019 •

edited

Loading

jreback commented Dec 12, 2019

MarcoGorelli commented Dec 19, 2019

DataFrame could have a to_markdown method. #11052

DataFrame could have a to_markdown method. #11052

Comments

petebachant commented Sep 10, 2015

TomAugspurger commented Sep 10, 2015

petebachant commented Sep 10, 2015

TomAugspurger commented Sep 10, 2015

petebachant commented Sep 10, 2015

GitHub Markdown

Source

Results

Pandas HTML

Source

Results

hayd commented Sep 11, 2015

jankatins commented Nov 11, 2015

jreback commented Nov 11, 2015

jankatins commented Nov 11, 2015

ghost commented Nov 27, 2015

pstjohn commented Oct 11, 2017 • edited Loading

TomAugspurger commented Oct 11, 2017 via email

jreback commented Oct 11, 2017

aflaxman commented Nov 7, 2017

kangwonlee commented Dec 16, 2018

MarcoGorelli commented Dec 12, 2019 • edited Loading

jreback commented Dec 12, 2019

MarcoGorelli commented Dec 19, 2019

pstjohn commented Oct 11, 2017 •

edited

Loading

MarcoGorelli commented Dec 12, 2019 •

edited

Loading