plotnine-extra 0.1.0

Extension package for plotnine with extra geoms, stats, composition, and animation

plotnine-extra

Extension package for plotnine that adds extra geoms, stats, plot composition, and animation support.

Installation

pip install plotnine-extra

This will automatically install plotnine as a dependency.

Usage

from plotnine_extra import *

This imports all of plotnine's public API plus the extra components provided by this package. You can also import from plotnine and plotnine_extra separately:

from plotnine import ggplot, aes, geom_point
from plotnine_extra import geom_pointdensity, annotation_stripes

Extra Components

Geoms

• geom_pointdensity — Scatterplot with density estimation at each point
• geom_spoke — Line segments parameterised by location, direction, and distance
• annotation_stripes — Alternating background stripes, useful with geom_jitter

Stats

• stat_pointdensity — Compute density estimation for each point

Plot Composition

Compose multiple plots using operators:

• | — Arrange plots side by side (Beside)
• / — Arrange plots vertically (Stack)
• + — Arrange plots in a 2D grid (Wrap)
• - — Arrange plots side by side at the same nesting level
• & — Add to all plots in a composition
• * — Add to top-level plots only

from plotnine import ggplot, aes, geom_point
from plotnine.data import mtcars
from plotnine_extra import plot_layout, plot_annotation

p1 = ggplot(mtcars, aes("wt", "mpg")) + geom_point()
p2 = ggplot(mtcars, aes("hp", "mpg")) + geom_point()

# Side by side
p1 | p2

# Stacked
p1 / p2

# With layout control
(p1 | p2) + plot_layout(widths=[1, 2])

# With annotation
(p1 | p2) + plot_annotation(title="My Composition")

Additional composition classes and functions:

• Compose — Base class for compositions
• Beside, Stack, Wrap — Composition subclasses
• plot_layout — Customise composition layout (nrow, ncol, widths, heights)
• plot_annotation — Add title, subtitle, caption, footer to compositions
• plot_spacer — Add blank space in compositions

Animation

from plotnine import ggplot, aes, geom_point, lims
from plotnine_extra import PlotnineAnimation

plots = [
    ggplot(data_frame_i, aes("x", "y")) + geom_point() + lims(x=(0, 10), y=(0, 10))
    for data_frame_i in frames
]

ani = PlotnineAnimation(plots, interval=200)
ani.save("animation.gif")

Compatibility

• Requires Python ≥ 3.10
• Requires plotnine ≥ 0.15.3

Note: The composition and animation modules use plotnine's internal APIs and may break with future plotnine updates. Pin your plotnine version if stability is critical.

Development

git clone https://github.com/mdmanurung/plotnine-extra.git
cd plotnine-extra
pip install -e ".[all]"

Publishing to PyPI

This project uses trusted publishing (OIDC) via GitHub Actions — no API tokens needed.

One-time setup

1. Create accounts on PyPI and TestPyPI

2. Add trusted publishers on both PyPI and TestPyPI:

   • Go to your account → Publishing → Add a new pending publisher
   • Fill in:
     • PyPI project name: plotnine-extra
     • Owner: mdmanurung
     • Repository: plotnine-extra
     • Workflow name: publish.yml
     • Environment name: pypi (for PyPI) or testpypi (for TestPyPI)

3. Create GitHub environments in your repository settings:

   • Go to Settings → Environments
   • Create two environments: pypi and testpypi

How to publish

• To TestPyPI: Go to Actions → "Publish to PyPI / TestPyPI" → Run workflow → select testpypi
• To PyPI: Create a GitHub Release (tag it as v0.1.0, etc.) — publishing happens automatically

Version bumping

Before publishing a new version, update the version in both:

• pyproject.toml → version = "X.Y.Z"
• plotnine_extra/__init__.py → __version__ = "X.Y.Z"

License

MIT License (same as plotnine)