pandas.Series.to_markdown#

Series.to_markdown(buf=None,mode='wt',index=True,storage_options=None,**kwargs)[source]#

Print Series in Markdown-friendly format.

Parameters:

bufstr, Path or StringIO-like, optional, default None

Buffer to write to. If None, the output is returned as a string.

modestr, optional

Mode in which file is opened, “wt” by default.

indexbool, optional, default True

Add index (row) labels.

storage_optionsdict, optional

Extra options that make sense for a particular storage connection, e.g.host, port, username, password, etc. For HTTP(S) URLs the key-value pairsare forwarded tourllib.request.Request as header options. For otherURLs (e.g. starting with “s3://”, and “gcs://”) the key-value pairs areforwarded tofsspec.open. Please seefsspec andurllib for moredetails, and for more examples on storage options referhere.

**kwargs

These parameters will be passed totabulate.

Returns:

str

Series in Markdown-friendly format.

Notes

Requires thetabulate package.

Examples

>>>s=pd.Series(["elk","pig","dog","quetzal"],name="animal")>>>print(s.to_markdown())|    | animal   ||---:|:---------||  0 | elk      ||  1 | pig      ||  2 | dog      ||  3 | quetzal  |

Output markdown with a tabulate option.

>>>print(s.to_markdown(tablefmt="grid"))+----+----------+|    | animal   |+====+==========+|  0 | elk      |+----+----------+|  1 | pig      |+----+----------+|  2 | dog      |+----+----------+|  3 | quetzal  |+----+----------+