https://github.com/practical-data-science/gilfoyle

Gilfoyle is a report generation tool for Python which makes it quick and easy to create stylish reports or presentations using data.
https://github.com/practical-data-science/gilfoyle

Last synced: 4 months ago
JSON representation

Gilfoyle is a report generation tool for Python which makes it quick and easy to create stylish reports or presentations using data.

• Host: GitHub
• URL: https://github.com/practical-data-science/gilfoyle
• Owner: practical-data-science
• License: mit
• Created: 2021-04-14T13:43:37.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-13T18:49:52.000Z (9 months ago)
• Last Synced: 2024-11-03T06:09:58.246Z (4 months ago)
• Language: Python
• Homepage:
• Size: 302 KB
• Stars: 25
• Watchers: 1
• Forks: 12
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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