About proplot

🎨 A succinct matplotlib wrapper for making beautiful, publication-quality graphics

p

Published by

proplot-dev

Visit View Profile

README.md

View on GitHub

.. image:: https://github.com/proplot-dev/proplot/blob/master/docs/_static/logo_long.svg?raw=true :width: 1000px

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

Ultraplot: Proplot's Spiritual Successor

Development on proplot has been indefinitely halted since summer 2023. A spiritual successor in ultraplot has been launched. It uses the proplot codebase and has modernized it to support recent versions of matplotlib, cartopy, python, etc. and is adding new features and enhancements. Check out the project over at the ultraplot repo <https://github.com/Ultraplot/ultraplot> and ultraplot docs <https://ultraplot.readthedocs.io/en/latest/>!

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/proplot-dev/proplot.git or clone the repository and run pip install -e . inside the proplot folder.

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

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

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

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

.. |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

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

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

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

.. |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/proplot-dev/proplot/branch/master/graph/badge.svg :alt: coverage :target: https://codecov.io/gh/proplot-dev/proplot

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

.. |hits| image:: http://hits.dwyl.com/proplot-dev/proplot.svg :alt: hits :target: http://hits.dwyl.com/proplot-dev/proplot