A Python library for creating stories from data
Branch: master
Clone or download
Latest commit 5927658 Jan 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
reportermate updated tests Feb 1, 2019
tests updated tests Feb 1, 2019
.gitignore updated demo data Jul 4, 2017
LICENCE.txt added licence Jan 16, 2019
README.md many updates Jan 16, 2019
README.rst many updates Jan 16, 2019
requirements.txt
setup.py

README.md

ReporterMate

Reportermate is an open source project to create an automated news reporting system. This library forms the base of the system, and combines the pandas data analysis library, the handlebars templating language, and a whole bunch of helper functions to automate the generation of text reports from data.

Installation

pip install reportermate

Usage

Installing the reportermate lib adds the reportermate function to your command line.

reportermate my-data.csv my-template.txt

Using this function will take your data and then analyse and render it according to the template provided.

To use reportermate from within another python script, import the analyseAndRender function:

from reportermate import analyseAndRender
analyseAndRender(my-data.csv,my-template.txt)

To see working examples and templates, check out the tests folder.

Templates

Reportermate uses the handlebars template language to define the analysis of the dataset, and how the results should be rendered into text. The template functions are the key to generating your text results.

Template function definitions and examples coming soon...