Metadata-Version: 2.1
Name: dftogithubmarkdown
Version: 0.10
Summary: DataFrame to GitHub markdown table
Home-page: https://github.com/hansalemaos/dftogithubmarkdown
Author: Johannes Fischer
Author-email: aulasparticularesdealemaosp@gmail.com
License: MIT
Keywords: GitHub,markdown,dataframe
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
License-File: LICENSE.rst
Requires-Dist: pandas


# A function to convert DataFrames to GitHub markdown

## `pip install dftogithubmarkdown`


```py
from dftogithubmarkdown import to_git_markdown
print(to_git_markdown(df, max_col_width=30, max_rows=-1))
"""
Convert a pandas DataFrame to a GitHub-flavored markdown table string.

Parameters:
df (pd.DataFrame): The DataFrame to convert.
max_col_width (int): Maximum width for each column in the markdown table. Default is 30.
max_rows (int): Maximum number of rows to include in the table. If -1, include all rows.

Returns:
str: A string representing the DataFrame in GitHub-flavored markdown table format.
"""



```
