   
# DataFrame Summary Tools in Jupyter Notebook
This is python version of `summarytools`, which is used to generate standardized and comprehensive summary of dataframe in Jupyter Notebooks.
The idea is originated from the `summarytools` R package (https://github.com/dcomtois/summarytools).
* Only `dfSummary` function is made available for now
* Added two html widgets to avoid displaying lengthy content
+ [collapsible summary](#collapsible-summary)
+ [tabbed summary](#tabbed-summary)
# Installation
```
pip install jupyter-summarytools
```
## Dependencies
1. python 3.6+
2. pandas >= 1.4.0
# Quick Start
the quick-start notebook is available in [here](https://github.com/6chaoran/jupyter-summarytools/blob/master/quick-start.ipynb)
out-of-box `dfSummary` function will generate a HTML based data frame summary.
```py
import pandas as pd
from summarytools import dfSummary
titanic = pd.read_csv('./data/titanic.csv')
dfSummary(titanic)
```
## collapsible summary
```py
import pandas as pd
from summarytools import dfSummary
titanic = pd.read_csv('./data/titanic.csv')
dfSummary(titanic, is_collapsible = True)
```
## tabbed summary
```py
import pandas as pd
from summarytools import dfSummary, tabset
titanic = pd.read_csv('./data/titanic.csv')
vaccine = pd.read_csv('./data/country_vaccinations.csv')
vaccine['date'] = pd.to_datetime(vaccine['date'])
tabset({
'titanic': dfSummary(titanic).render(),
'vaccine': dfSummary(vaccine).render()})
```
# Export notebook as HTML
when export jupyter notebook to HTML, make sure `Export Embedded HTML
` extension is installed and enabled.
Using the following bash command to retain the data frame summary in exported HTML.
```bash
jupyter nbconvert --to html_embed path/of/your/notebook.ipynb
```
Raw data
{
"_id": null,
"home_page": "https://github.com/6chaoran/jupyter-summarytools",
"name": "jupyter-summarytools",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "sample,setuptools,development",
"author": "Liu Chaoran",
"author_email": "6chaoran@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a7/19/d082d174b21d4e4b9fd92898b2ce27fda94a251b541cf186e3672f95258e/jupyter-summarytools-0.2.3.tar.gz",
"platform": null,
"description": " \r\n\r\n   \r\n\r\n# DataFrame Summary Tools in Jupyter Notebook\r\n\r\nThis is python version of `summarytools`, which is used to generate standardized and comprehensive summary of dataframe in Jupyter Notebooks.\r\n\r\nThe idea is originated from the `summarytools` R package (https://github.com/dcomtois/summarytools).\r\n\r\n* Only `dfSummary` function is made available for now\r\n* Added two html widgets to avoid displaying lengthy content\r\n + [collapsible summary](#collapsible-summary) \r\n + [tabbed summary](#tabbed-summary)\r\n\r\n# Installation\r\n\r\n```\r\npip install jupyter-summarytools\r\n```\r\n\r\n## Dependencies\r\n1. python 3.6+\r\n2. pandas >= 1.4.0\r\n\r\n# Quick Start\r\n\r\nthe quick-start notebook is available in [here](https://github.com/6chaoran/jupyter-summarytools/blob/master/quick-start.ipynb)\r\n\r\nout-of-box `dfSummary` function will generate a HTML based data frame summary.\r\n\r\n```py\r\nimport pandas as pd\r\nfrom summarytools import dfSummary\r\ntitanic = pd.read_csv('./data/titanic.csv')\r\ndfSummary(titanic)\r\n```\r\n\r\n\r\n## collapsible summary\r\n\r\n```py\r\nimport pandas as pd\r\nfrom summarytools import dfSummary\r\ntitanic = pd.read_csv('./data/titanic.csv')\r\ndfSummary(titanic, is_collapsible = True)\r\n```\r\n\r\n\r\n\r\n## tabbed summary\r\n\r\n```py\r\nimport pandas as pd\r\nfrom summarytools import dfSummary, tabset\r\ntitanic = pd.read_csv('./data/titanic.csv')\r\nvaccine = pd.read_csv('./data/country_vaccinations.csv')\r\nvaccine['date'] = pd.to_datetime(vaccine['date'])\r\n\r\ntabset({\r\n 'titanic': dfSummary(titanic).render(),\r\n 'vaccine': dfSummary(vaccine).render()})\r\n```\r\n\r\n\r\n\r\n# Export notebook as HTML\r\n\r\nwhen export jupyter notebook to HTML, make sure `Export Embedded HTML\r\n` extension is installed and enabled.\r\n\r\n\r\n\r\nUsing the following bash command to retain the data frame summary in exported HTML.\r\n```bash\r\njupyter nbconvert --to html_embed path/of/your/notebook.ipynb\r\n```\r\n",
"bugtrack_url": null,
"license": "",
"summary": "summarytools in jupyter notebook",
"version": "0.2.3",
"split_keywords": [
"sample",
"setuptools",
"development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af4f5b948e54709d499dfc3d890df36b1e2a924b761305b8a48619baf67c6b13",
"md5": "6d53bfe83ccb3babf4dfbc5878991aa9",
"sha256": "e93aa39d88df7f8607a897bc2144b43808f166dbb5f4c6c684f4d018990732bc"
},
"downloads": -1,
"filename": "jupyter_summarytools-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d53bfe83ccb3babf4dfbc5878991aa9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12130,
"upload_time": "2023-04-17T03:30:33",
"upload_time_iso_8601": "2023-04-17T03:30:33.384257Z",
"url": "https://files.pythonhosted.org/packages/af/4f/5b948e54709d499dfc3d890df36b1e2a924b761305b8a48619baf67c6b13/jupyter_summarytools-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a719d082d174b21d4e4b9fd92898b2ce27fda94a251b541cf186e3672f95258e",
"md5": "116b77cc6d041b2af682d8167783659f",
"sha256": "707f614bbcbdb68da99c8926df9200d37fd7dfd445713e5c643295f5617b4127"
},
"downloads": -1,
"filename": "jupyter-summarytools-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "116b77cc6d041b2af682d8167783659f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 13989,
"upload_time": "2023-04-17T03:30:34",
"upload_time_iso_8601": "2023-04-17T03:30:34.811377Z",
"url": "https://files.pythonhosted.org/packages/a7/19/d082d174b21d4e4b9fd92898b2ce27fda94a251b541cf186e3672f95258e/jupyter-summarytools-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-17 03:30:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "6chaoran",
"github_project": "jupyter-summarytools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "jupyter-summarytools"
}
JSON
