# 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.
"""
```
Raw data
{
"_id": null,
"home_page": "https://github.com/hansalemaos/dftogithubmarkdown",
"name": "dftogithubmarkdown",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "GitHub, markdown, dataframe",
"author": "Johannes Fischer",
"author_email": "aulasparticularesdealemaosp@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b8/3e/7dc29f39d8e99912e8f609ebf37ce66158340abca5c21a2fe5053b09f400/dftogithubmarkdown-0.10.tar.gz",
"platform": null,
"description": "\r\n# A function to convert DataFrames to GitHub markdown\r\n\r\n## `pip install dftogithubmarkdown`\r\n\r\n\r\n```py\r\nfrom dftogithubmarkdown import to_git_markdown\r\nprint(to_git_markdown(df, max_col_width=30, max_rows=-1))\r\n\"\"\"\r\nConvert a pandas DataFrame to a GitHub-flavored markdown table string.\r\n\r\nParameters:\r\ndf (pd.DataFrame): The DataFrame to convert.\r\nmax_col_width (int): Maximum width for each column in the markdown table. Default is 30.\r\nmax_rows (int): Maximum number of rows to include in the table. If -1, include all rows.\r\n\r\nReturns:\r\nstr: A string representing the DataFrame in GitHub-flavored markdown table format.\r\n\"\"\"\r\n\r\n\r\n\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DataFrame to GitHub markdown table",
"version": "0.10",
"project_urls": {
"Homepage": "https://github.com/hansalemaos/dftogithubmarkdown"
},
"split_keywords": [
"github",
" markdown",
" dataframe"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f05e55861b478ed0549430353c29e7b498f03a0d6ffea079b1b3d6cde7f59cd",
"md5": "6e506efd561125416d1093880f8d6357",
"sha256": "8260cd8bb11e52860ac87f32c8117bac5f3b32f7e18d8008cd48c30c4d927dfa"
},
"downloads": -1,
"filename": "dftogithubmarkdown-0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e506efd561125416d1093880f8d6357",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5931,
"upload_time": "2025-02-16T02:40:18",
"upload_time_iso_8601": "2025-02-16T02:40:18.943210Z",
"url": "https://files.pythonhosted.org/packages/4f/05/e55861b478ed0549430353c29e7b498f03a0d6ffea079b1b3d6cde7f59cd/dftogithubmarkdown-0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b83e7dc29f39d8e99912e8f609ebf37ce66158340abca5c21a2fe5053b09f400",
"md5": "c8c47c94733881086a02198589c8ae96",
"sha256": "95d2fe35a0002083da843e62296abc43b55df818182fe7c34c6bae0cbba36e05"
},
"downloads": -1,
"filename": "dftogithubmarkdown-0.10.tar.gz",
"has_sig": false,
"md5_digest": "c8c47c94733881086a02198589c8ae96",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4236,
"upload_time": "2025-02-16T02:40:20",
"upload_time_iso_8601": "2025-02-16T02:40:20.910643Z",
"url": "https://files.pythonhosted.org/packages/b8/3e/7dc29f39d8e99912e8f609ebf37ce66158340abca5c21a2fe5053b09f400/dftogithubmarkdown-0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-16 02:40:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hansalemaos",
"github_project": "dftogithubmarkdown",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pandas",
"specs": []
}
],
"lcname": "dftogithubmarkdown"
}
JSON
