.. image:: https://github.com/lukelbd/proplot/blob/master/docs/logo_long.png?raw=true
   :width: 1000px

|build-status| |docs| |pypi| |code-style| |pr-welcome| |license| |gitter| |doi|

A succinct `matplotlib <https://matplotlib.org/>`__ wrapper for making beautiful,
publication-quality graphics.

Documentation
=============

The documentation is `published on readthedocs <https://proplot.readthedocs.io>`__.

Installation
============

Proplot is published on `PyPi <https://pypi.org/project/proplot/>`__ and
`conda-forge <https://conda-forge.org>`__. It can be installed with ``pip`` or
``conda`` as follows:

.. code-block:: bash

   pip install proplot
   conda install -c conda-forge proplot

Likewise, an existing installation of proplot can be upgraded
to the latest version with:

.. code-block:: bash

   pip install --upgrade proplot
   conda upgrade proplot

To install a development version of proplot, you can use
``pip install git+https://github.com/lukelbd/proplot.git``
or clone the repository and run ``pip install -e .``
inside the ``proplot`` folder.


.. |code-style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :alt: black
   :target: https://github.com/psf/black

.. |build-status| image:: https://travis-ci.com/lukelbd/proplot.svg?branch=master
   :alt: build status
   :target: https://travis-ci.com/lukelbd/proplot

.. |license| image:: https://img.shields.io/github/license/lukelbd/proplot.svg
   :alt: license
   :target: LICENSE.txt

.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3873878.svg
   :alt: doi
   :target: https://doi.org/10.5281/zenodo.3873878

.. |docs| image:: https://readthedocs.org/projects/proplot/badge/?version=latest
   :alt: docs
   :target: https://proplot.readthedocs.io/en/latest/?badge=latest

.. |pr-welcome| image:: https://img.shields.io/badge/PR-Welcome-green.svg?
   :alt: PR welcome
   :target: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project

.. |pypi| image:: https://img.shields.io/pypi/v/proplot?color=83%20197%2052
   :alt: pypi
   :target: https://pypi.org/project/proplot/

.. |gitter| image:: https://badges.gitter.im/gitterHQ/gitter.svg
   :alt: gitter
   :target: https://gitter.im/pro-plot/community


..
   |code-style| image:: https://img.shields.io/badge/code%20style-pep8-green.svg
   :alt: pep8
   :target: https://www.python.org/dev/peps/pep-0008/

..
   |coverage| image:: https://codecov.io/gh/lukelbd/proplot.org/branch/master/graph/badge.svg
   :alt: coverage
   :target: https://codecov.io/gh/lukelbd/proplot.org

..
   |quality| image:: https://api.codacy.com/project/badge/Grade/931d7467c69c40fbb1e97a11d092f9cd
   :alt: quality
   :target: https://www.codacy.com/app/lukelbd/proplot?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=lukelbd/proplot&amp;utm_campaign=Badge_Grade

..
   |hits| image:: http://hits.dwyl.io/lukelbd/lukelbd/proplot.svg
   :alt: hits
   :target: http://hits.dwyl.io/lukelbd/lukelbd/proplot

..
   |contributions| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
   :alt: contributions
   :target: https://github.com/lukelbd/issues

..
   |issues| image:: https://img.shields.io/github/issues/lukelbd/proplot.svg
   :alt: issues
   :target: https://github.com/lukelbd/issues
