Metadata-Version: 2.1
Name: teeplot
Version: 0.6.2
Summary: teeplot automatically saves a copy of rendered Jupyter notebook plots
Home-page: https://github.com/mmore500/teeplot
Author: Matthew Andres Moreno
Author-email: m.more500@gmail.com
License: MIT license
Keywords: teeplot
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.6
Requires-Dist: keyname >=0.5.2
Requires-Dist: matplotlib >=3.3.2
Requires-Dist: numpy >=1.19.5
Requires-Dist: pandas >=1.1.2
Requires-Dist: python-slugify >=4.0.1

============
teeplot
============


.. image:: https://img.shields.io/pypi/v/teeplot.svg
        :target: https://pypi.python.org/pypi/teeplot

.. image:: https://img.shields.io/travis/mmore500/teeplot.svg
        :target: https://travis-ci.com/mmore500/teeplot

.. image:: https://readthedocs.org/projects/teeplot/badge/?version=latest
        :target: https://teeplot.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status




teeplot automatically saves a copy of rendered Jupyter notebook plots


* Free software: MIT license
* Documentation: https://teeplot.readthedocs.io.


.. code-block:: python3

  from teeplot import teeplot as tp
  import seaborn as sns

  # adapted from https://seaborn.pydata.org/examples/errorband_lineplots.html
  tp.tee(
    sns.lineplot,
    x='timepoint',
    y='signal',
    hue='region',
    style='event',
    data=sns.load_dataset('fmri'),
    teeplot_outattrs={
      'additional' : 'metadata',
      'for' : 'output-filename',
    },
  )

  tp.tee(
    sns.catplot,
    data=sns.load_dataset('penguins'),
    kind='bar',
    x='species',
    y='body_mass_g',
    hue='sex',
    ci='sd',
    palette='dark',
    alpha=.6,
    height=6,
  )

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.1.0 (2021-04-01)
------------------

* First release on PyPI.


