# Gilfoyle
Gilfoyle is a report generation tool for Python which makes it quick and easy to create stylish looking reports or presentations using data.
#### Installation
You can install Gilfoyle by entering `pip3 install gilfoyle-forked` in your terminal.
#### Usage
Gilfoyle can be used within a regular Python script or from inside a Jupyter notebook. See the `example.py`
file for some working examples.
```python
# Load packages
import pandas as pd
from gilfoyle import report
# Define output filename
pdf = report.Report(output='example.pdf')
# Set report title
pdf.set_title('Monthly ecommerce report')
# Create payload
payload = pdf.get_payload()
# Add a cover slide
payload = pdf.add_page(payload,
page_type='cover',
page_title='Monthly report',
page_subheading='Matt Clarke')
# Fetch your data
df = pd.read_csv('data.csv',
skiprows=1,
names=['Period', 'Entrances', 'Sessions', 'Pageviews',
'Transactions', 'Conversion Rate', 'AOV']).head(13)
payload = pdf.add_page(payload,
page_type='report',
page_layout='simple',
page_title='Organic search',
page_dataframe=df
)
# Save to PDF
pdf.create_report(payload, verbose=True, output='pdf')
```
#### Dependencies
Gilfoyle is written in Python 3 and uses the Jinja 2 templating engine, the Bulma HTML and CSS framework, and the Weasyprint PDF generator package. Gilfoyle is compatible with Pandas and can automatically turn your dataframes into tables.
Raw data
{
"_id": null,
"home_page": "https://github.com/sr-auto/gilfoyle",
"name": "gilfoyle-forked",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, reports, reporting, pandas, pdf",
"author": "Shahab Rashid",
"author_email": "sr.python10@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8d/0a/847d2d0acdedba48e3f552aa52f0d13889f5eb52c6d60ff1195e75cbedeb/gilfoyle_forked-1.2.0.tar.gz",
"platform": null,
"description": "# Gilfoyle\nGilfoyle is a report generation tool for Python which makes it quick and easy to create stylish looking reports or presentations using data. \n\n#### Installation\nYou can install Gilfoyle by entering `pip3 install gilfoyle-forked` in your terminal. \n\n#### Usage\nGilfoyle can be used within a regular Python script or from inside a Jupyter notebook. See the `example.py`\nfile for some working examples. \n\n```python\n# Load packages\nimport pandas as pd\nfrom gilfoyle import report\n\n# Define output filename\npdf = report.Report(output='example.pdf')\n\n# Set report title\npdf.set_title('Monthly ecommerce report')\n\n# Create payload\npayload = pdf.get_payload()\n\n# Add a cover slide\npayload = pdf.add_page(payload,\n page_type='cover',\n page_title='Monthly report',\n page_subheading='Matt Clarke')\n\n# Fetch your data\ndf = pd.read_csv('data.csv', \n skiprows=1,\n names=['Period', 'Entrances', 'Sessions', 'Pageviews',\n 'Transactions', 'Conversion Rate', 'AOV']).head(13)\n\npayload = pdf.add_page(payload,\n page_type='report',\n page_layout='simple',\n page_title='Organic search',\n page_dataframe=df\n )\n\n# Save to PDF\npdf.create_report(payload, verbose=True, output='pdf')\n```\n\n\n#### Dependencies\n\nGilfoyle is written in Python 3 and uses the Jinja 2 templating engine, the Bulma HTML and CSS framework, and the Weasyprint PDF generator package. Gilfoyle is compatible with Pandas and can automatically turn your dataframes into tables. \n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Gilfoyle is a Python-based report generator for data scientists who use Pandas.",
"version": "1.2.0",
"project_urls": {
"Download": "https://github.com/sr-auto/gilfoyle/archive/master.zip",
"Homepage": "https://github.com/sr-auto/gilfoyle"
},
"split_keywords": [
"python",
" reports",
" reporting",
" pandas",
" pdf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7fcae2238c17fd9786c0e23d90709823924452a7d7ed789385ee2e45928a3c29",
"md5": "1e3577736505c9740a10c35b9e864b02",
"sha256": "5defb5750aade6e049fa9de273a5e1eeb57abd6903f645894d59b7962b66e35d"
},
"downloads": -1,
"filename": "gilfoyle_forked-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1e3577736505c9740a10c35b9e864b02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 99994,
"upload_time": "2024-05-14T15:18:06",
"upload_time_iso_8601": "2024-05-14T15:18:06.717052Z",
"url": "https://files.pythonhosted.org/packages/7f/ca/e2238c17fd9786c0e23d90709823924452a7d7ed789385ee2e45928a3c29/gilfoyle_forked-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d0a847d2d0acdedba48e3f552aa52f0d13889f5eb52c6d60ff1195e75cbedeb",
"md5": "b9149ba66b1fed40274da26bc98e9ead",
"sha256": "6bf95dba7f37c8bb229d440d55dae66208b79e26acbf4d5ca4432eaa3b66faa5"
},
"downloads": -1,
"filename": "gilfoyle_forked-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "b9149ba66b1fed40274da26bc98e9ead",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 100058,
"upload_time": "2024-05-14T15:18:08",
"upload_time_iso_8601": "2024-05-14T15:18:08.631458Z",
"url": "https://files.pythonhosted.org/packages/8d/0a/847d2d0acdedba48e3f552aa52f0d13889f5eb52c6d60ff1195e75cbedeb/gilfoyle_forked-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-14 15:18:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sr-auto",
"github_project": "gilfoyle",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gilfoyle-forked"
}
JSON
