Data Visualization and Report Building
Project description
PyBloqs is a flexible framework for visualizing data and automated creation of reports.
It works with Pandas, matplotlib and highcharts. PyBloqs creates atomic blocks containing text, tables (from Pandas DataFrame), plots (matplotlib or highcharts) or images. All blocks can be styled with CSS. Each block can be created and displayed separately for fast development turnover. Lists of blocks can be stacked together to form reports. Reports can be displayed as HTML in the browser or exported in a variety of formats (including HTML, PDF, SVG, PNG).
Quickstart
Install PyBloqs
For a minimal install without HighCharts support run:
pip install pybloqs
or when installing in development mode:
python setup.py develop
This will allow you to run the example code below.
External dependencies
For full functionality, PyBloqs requires the following 3rd party programs and libraries. For some, the file location must be specified at install time:
pip install --install-option="INSTALL OPTIONS" git+https://github.com/manahl/pybloqs.git
e.g.
pip install --install-option="--highcharts=~/node_modules/highcharts/,~/node_modules/highcharts-heatmap/" git+https://github.com/manahl/pybloqs.git
Libraries bundled with PyBloqs:
jsinflate.js (https://github.com/augustl/js-inflate; MIT License)
jquery.js (https://jquery.com; MIT License)
jquery-DataTables.js (https://datatables.net; MIT License)
wkhtmltopdf/wkhtmltoimage (http://wkhtmltopdf.org/; LGPLv3):
wkhtmltopdf is not bundled with PyBloqs. You need to install it from your distribution’s repository (Linux) or download it from the project page (https://wkhtmltopdf.org) . The binaries wkhtmltopdf and wkhtmltoimage are used for file output other than HTML. PyBloqs will search for the binaries on the system path. If you would like to use a local copy of the binaries, install with following option:
--wkhtmltopdf=/path/to/binary
When installing in development mode you can load highcharts explicitly:
python setup.py load_wkhtmltopdf --wkhtmltopdf=/path/to/binary
HighCharts (optional; proprietery license, see https://shop.highsoft.com/highcharts-t2):
Highcharts is not bundled with PyBloqs. To create blocks with Highcharts plots, you need to download Highcharts separately (e.g. with npm install highcharts, npm install highcharts-heatmap etc.), and provide the path to your highcharts installation. Please make sure you have the right license for Highcharts. For full functionality you will need the following highcharts packages: highcharts, highcharts-heatmap, highcharts-funnel, highcharts-exporting, highcharts-export-csv (this example assumes, npm installed files into directory ~/node_modules).
--highcharts=~/node_modules/highcharts/, ~/node_modules/highcharts-heatmap/,~/node_modules/highcharts-funnel,~/node_modules/highcharts-exporting, ~/node_modules/highcharts-export-csv
When installing in development mode you can load highcharts explicitly (this example assumes, npm installed files into directory ~/node_modules)
python setup.py load_highcharts --highcharts=~/node_modules/highcharts/,~/node_modules/highcharts-heatmap/,\ ~/node_modules/highcharts-funnel,~/node_modules/highcharts-exporting,~/node_modules/highcharts-export-csv
Using PyBloqs
from pybloqs import Block, HStack, VStack import pandas as pd from matplotlib import pyplot as plt text_block = Block('This is a text block', styles={'text-align':'center', 'color':'blue'}) text_block.show() df = pd.DataFrame([[1., 2.],[3.,4.]], columns =['a', 'b']) table_block = Block(df) table_block.show() plot_block = Block(plt.plot(df['a'], df['b'])) plot_block.show() plot_and_table = HStack([plot_block, table_block]) report = VStack([text_block, plot_and_table]) report.show() report.save('report.pdf')
Configuration
You can specify per-user default parameters in a yaml-formatted file ~/.pybloqs.cfg:
user_email_address: some@email.com # Default: user name public_dir: /some/dir # Default: /tmp tmp_html_dir: /some/dir # Default: /tmp smtp_server: url.for.email.server # Default: ''
Documentation
Have a look at the detailed documentation.
Requirements
PyBloqs works with:
matplotlib
Pandas
html5lib
lxml
jinja2
markdown
beautifulsoup4
docutils
Acknowledgements
PyBloqs has been under active development at Man AHL since 2013.
Original concept and implementation: Tom Farnbauer
Contributors from AHL Tech team:
… and many others …
Contributions welcome!
License
PyBloqs is licensed under the GNU LGPL v2.1. A copy of which is included in LICENSE
Changelog
1.0.0 (2017-04-07)
Initial public release
1.0.1 (2017-04-13)
Integration with pypi and ReadTheDocs.
Installation on Mac and Windows.
1.0.2 (2017-04-26)
Metadata and badge for Python version.
Python 3 compatibility changes, part 1.
Installation with Coveralls.
1.0.3 (2017-04-26)
Bugfix: Import of urlparse corrected, fixes Block.show() .
1.1.0 (2017-05-10)
jQuery DataTables support.
HTML anchors.
Bugfix: Width of HTML-body no longer hard-coded.
1.1.1 (2017-05-10)
Bugfix: Static data including DataTables CSS.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file pybloqs-1.1.1.tar.gz
.
File metadata
- Download URL: pybloqs-1.1.1.tar.gz
- Upload date:
- Size: 123.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d9575aea08c1a21ebbb5ffe65b56196c30134559ac1fce0b9f71c593e73e084 |
|
MD5 | 71fa0605205c4009a3c81eb49cb1e955 |
|
BLAKE2b-256 | 783d426d5cfc4ef05a5cde9fa9c94ac56b6af960b7217721cf2e853898e78a96 |
File details
Details for the file pybloqs-1.1.1-py2.7.egg
.
File metadata
- Download URL: pybloqs-1.1.1-py2.7.egg
- Upload date:
- Size: 117.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb4eef9fbbc484bf4d8b540b774888be0f8f2979b453bb0a4a2c99d72347f547 |
|
MD5 | eb263a7a5cd645485819d5d9292791f7 |
|
BLAKE2b-256 | 90e93faa87a84f125af74d3a75a1f595fe053456192d8c48f45d109688357cc1 |
File details
Details for the file pybloqs-1.1.1-py2-none-any.whl
.
File metadata
- Download URL: pybloqs-1.1.1-py2-none-any.whl
- Upload date:
- Size: 122.2 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea4d756e4bdeeffa8dd1c928bdb00cee13755a15ccb934946d59dddb91f7e7bb |
|
MD5 | e73c27f17f6ab8833faec9d983bd729d |
|
BLAKE2b-256 | 701891f30339f3c8de9378f55fb52d955c5bd6efa943d54db5b780b5aa041e2e |