Metadata-Version: 2.1
Name: blume
Version: 0.2.2
Summary: Better looking tables for matplotlib
Home-page: https://github.com/swfiua/blume
Author: Johnny Gill
Author-email: swfiua@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/swfiua/blume/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
License-File: LICENSE

=======
 Blume
=======

Better Looking Universal Matplotlib Engine.

Blume provides a replacement for the matplotlib table module.

Displaying data as tables in matplotlib.

It fixes a number of issues with the existing table and has:

* more reliable code for automatically setting the font size to make
  best use of the space available.

* Padding between text and the cell edges which works better across a
  range of text sizes.

* First row of cell data is now row 0 regardless of whether the table
  has a row header.  The row header is row -1.

* New options to allow cell edge colours to be specified.  

To use the new table, just import `blume.table` and use that to
create your tables instead of the `matplotlib.table.table`.
  
::

   from blume import table

   tab = table(ax, ..)


The first parameter to table should be an *matplotlib.axes*.

If you are using the *pyplot* interface, note that calling
*pyplot.table* will use `matplotlib.table.table`.

Instead import table from blume and use as follows::

  from blume.table import table
  tab = table(plt.gca(), ...)


And lots more
=============

The general theme is how to create generic tools to explore tables of
data, visualising the data with *matplotlib*.

Tools that also help with managing open data.

For small datasets, there is an evolving example of working with
simple csv files, stored in a git repository.   See `blume.examples.ocixx`.

Install
=======

From source code
----------------

Get the latest code::

  git clone http://github.com/swfiua/blume

Instal::

  python setup.py install


Using pip::

  pip3 install blume


Examples
========

The *blume/examples* folder has a number of demonstrations of what can be
done with this table.

You can run these with python3:

    python3 -m blume.example.cpr

Or you can run a folder full of examples by using `blume.eggshow`.
    

Requirements
============

The package will only require an *appropriate* version of matplotlib.

This is to make it easy for anyone who is only here for the table.


Universal
=========

The U in `blume`.

This for now is the `blume.cpr` module.

Testing
=======

Run tests using::

  pytest tests




