Skip to main content

A plotting package for the Brookings Institution

Project description

pyplotbrookings

Overview

pyplotbrookings is a matplotlib extension which implements the Brookings style guide. It offers several color palettes, a custom theme, and a few helper functions. pyplotbrookings is a python implementation of ggbrookings, an R extension for ggplot.

Installation

Currently pyplotbrookings is not an official python package. If you would like to demo this module please download this repository and import it into a python script. The current alias for for pyplotbrookings is ppb. For example,

import pyplotbrookings as ppb

Usage

The pyplotbrookings package has a few simple user facing functions:

  • set_theme() overrides the default matplotlib theme for a custom one which adheres to the Brookings style guide.

  • set_palette() sets the matplotlib color cycler to one of several color palettes that are consistent with the Brookings brand and designed to provide color accessiblity.

  • add_title() adds titles and subtitles to a plot that are consistent with Brookings brand guidelines.

  • add_logo() adds a program/center logo to your plots after saving them.

  • get_camp() returns a continuous palette (or color map) using one of the color Brookings color palettes.

  • view_palette() helper function that previews a color palette showing both the order of palette and the appropriate text color that can be applied to each color.

  • import_roboto() imports and overrides the default matplotlib font (sans serif) to Roboto. Note, Roboto fonts come with this module so no additional font download is necessary.

  • figure() creates a matplotlib figure in one of the standard Brookings sizes.

  • save() saves a figure in the Brookings advised dpi values depending on content type.

Palette dictionaries (palettes and extended_palettes) for pyplotbrookings can also be used directly but only for lookup and not assignment.

Examples

Examples can be found in the attached Jupyter Notebook.

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

pyplotbrookings-0.0.0.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

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

pyplotbrookings-0.0.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file pyplotbrookings-0.0.0.tar.gz.

File metadata

  • Download URL: pyplotbrookings-0.0.0.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.13

File hashes

Hashes for pyplotbrookings-0.0.0.tar.gz
Algorithm Hash digest
SHA256 841ec1ec79dcdf0aa00933e624ba99f486450df3cf463247d4f48a753d9df79e
MD5 4fab795181c6b814675e6118668999e2
BLAKE2b-256 d3a35185f682fff2a69c3ec9e57e8ee4094841006ba44a2212d944472b5fc988

See more details on using hashes here.

File details

Details for the file pyplotbrookings-0.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pyplotbrookings-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0fbd960dfd6c97d232e7d63011ff46498c344a271a46114290b4f47af2f6270
MD5 32bc06599652c760898e0ba7f3fbbcb2
BLAKE2b-256 a38acc90207fbebab6bac7f295f10de9e3768a108b16d885bd4cd637634ece81

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