Skip to main content

Data Visualization and Report Building

Project description

pybloqs

PyBloqs is a flexible framework for visualizing data and automated creation of "good enough" reports.

CircleCI PyPI ReadTheDocs Coverage Status


PyBloqs in use in ipython notebook

Sometimes all you want is a quick and easy way to generate a static report. No bells, no whistles, no server setup and no network permissions. Just a PDF, html file or even a PNG.

PyBloqs is the simple solution for creating such data-rich reports.

It works with Pandas, matplotlib and highcharts and more. See your blocks in a notebook, in the browser, or as an image, and easily share them via the filesystem or email!

PyBloqs creates atomic blocks containing text, tables (from data frames), plots (matplotlib, plotly 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

$ pip install pybloqs

See the documentation for further installation instructions.

Using PyBloqs

Please consult the user guide for more in-depth usage.

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. See the configuration section of the documentation for more details.

Requirements

Please see pyproject.toml for a list of dependencies, and the installation guide for details on optional dependencies.

Acknowledgements

PyBloqs has been under active development at Man AHL since 2013.

Original concept and implementation:

Tom Farnbauer

Contributors:

Dominik Christ Barry Fitzgerald Wilfred Hughes James Munro Bogdan Cozmaciuc Dave Jepson Jason Matthews Rhodi Richards Doug Bruce Jonathan Nye Matthew Dodds Han Wei Teo Manjunath Goudreddy Edwin Flores jamesoliverh Romain Morotti Robert Spencer Radu Andra James Hylands Kristof Szabo-Strell Jingwei Song Qiuyan Ge Timothy Chan and many others at Man Group and elsewhere...

Contributions welcome!

License

PyBloqs is licensed under the GNU LGPL v2.1. A copy of which is included in LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pybloqs-1.4.3.tar.gz (452.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pybloqs-1.4.3-py3-none-any.whl (202.3 kB view details)

Uploaded Python 3

File details

Details for the file pybloqs-1.4.3.tar.gz.

File metadata

  • Download URL: pybloqs-1.4.3.tar.gz
  • Upload date:
  • Size: 452.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for pybloqs-1.4.3.tar.gz
Algorithm Hash digest
SHA256 e711ba5d73e5c2930ea3fe37b5f4270c07063d0c9105e0f1afec9db5ca37ee81
MD5 8c4360c925a258e7f7c63a9ec0be26a7
BLAKE2b-256 d72794b19fd9fae1b4fe7e83b89174b29dc49ac5594f6377f25dc7ed725c3ace

See more details on using hashes here.

File details

Details for the file pybloqs-1.4.3-py3-none-any.whl.

File metadata

  • Download URL: pybloqs-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 202.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for pybloqs-1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 39c106081548bc89dcc212a91922b63f0e56e0ef25f79c3583aa2557644c27b0
MD5 7c29ccba35a2199a4988cc64cbb3f7c6
BLAKE2b-256 b896a759fc29378bf797bf67c2e494805d91ebd0486a51d63a0323059302acb8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page