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.

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

Metadata

Release files for gilfoyle 0.915

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gilfoyle 0.915
File	Size	Uploaded
gilfoyle-0.915.tar.gz	100.1 kB	Jul 26, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for gilfoyle 0.915
File	Interpreter	ABI	Platform	Reset
gilfoyle-0.915-py3-none-any.whl 99.8 kB Jul 26, 2021	Python 3	none	any	Details

Total release size: 199.8 kB

Release files / gilfoyle-0.915.tar.gz

Download URL	gilfoyle-0.915.tar.gz
Size	100.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`baf949248d6f38544d67cde7289b95872c4954f4b868a992821d1c35a0d1f6b4`
BLAKE2b-256 checksum How to use checksums	`85206dc5028c63a3db778c4a09473cedab089eb8bffe6745feb8a0bf21cb3540`
Upload date	Jul 26, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.4.2 requests/2.26.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.56.0 CPython/3.8.10`

Release files / gilfoyle-0.915-py3-none-any.whl

Download URL	gilfoyle-0.915-py3-none-any.whl
Size	99.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`10ca7c29e375926e04138b3f9bbff23853e57046d2237a3aa78c9461e4e334e5`
BLAKE2b-256 checksum How to use checksums	`31456832f455573c92e652036a9bb2ddb833e58d60d5bbb9f784f022ecdac896`
Upload date	Jul 26, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.4.2 requests/2.26.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.56.0 CPython/3.8.10`