Metadata-Version: 2.1
Name: gilfoyle-forked
Version: 1.1.0
Summary: Gilfoyle is a Python-based report generator for data scientists who use Pandas.
Home-page: https://github.com/sr-auto/gilfoyle
Download-URL: https://github.com/sr-auto/gilfoyle/archive/master.zip
Author: Shahab Rashid
Author-email: sr.python10@gmail.com
License: MIT
Keywords: python,reports,reporting,pandas,pdf
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: weasyprint
Requires-Dist: jinja2
Requires-Dist: seaborn

# 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. 

