Chorokit
A Python helper that creates clean choropleth maps with defaults for projection, layout, legend and other key configurations.
This project is in the early stages of development. Contributions and feedback welcome.
Core principles
- Easy to use: the common case works with one function call or CLI command
- Defaults first, flexibility when needed: well-designed defaults that you can override with small configs; explicit beats auto
- Speed: avoid unnecessary copies and Python loops; keep plotting fast for large GeoDataFrames
- Clean, production ready outputs: consistent spacing, legible labels, subtle legend; high DPI and exact canvas size
- Predictable and reproducible: deterministic classifications and colors when breaks are specified; versioned defaults
- Accessible and readable: offer color-vision-safe palettes and readable tick labels
- Small surface area: dataclasses capture configuration; CLI mirrors the Python API
- Composable design: separate modules for projection, legend and layout so parts can be swapped later
Install
pip install chorokit
For development:
git clone https://github.com/mstiles/chorokit.git
cd chorokit
pip install -e ".[dev]"
Usage
Basic Python example
import geopandas as gpd
from chorokit import plot_choropleth
gdf = gpd.read_file("data/states.geojson")
fig, ax = plot_choropleth(
gdf=gdf,
value="value_column",
title="headline",
subtitle="subhead",
source="Source: dataset",
)
fig.savefig("out.png", dpi=300)
Figure height is derived from the map's aspect ratio and the text/legend bands, so spacing stays consistent across geographies. Pass layout=LayoutConfig(width=10) to set the width in inches.
CLI example
chorokit data/states.geojson value_column --title "headline" --subtitle "subhead" --source "Source: dataset" -o out.png
Auto classification with top legend and projection
from chorokit import plot_choropleth, LegendConfig, LayoutConfig, Projection
legend = LegendConfig(
kind="binned",
title="value per 100k residents",
location="top",
scheme="quantiles",
k=5,
)
layout = LayoutConfig(
title="headline",
subtitle="subhead",
source="Source: dataset",
projection=Projection.us_albers(),
width=12,
)
fig, ax = plot_choropleth(gdf, value="value_column", cmap="Reds", legend=legend, layout=layout)
Projection override
# pass an EPSG code directly
fig, ax = plot_choropleth(gdf, value="value_column", projection=3857)
# or set in layout config
layout = LayoutConfig(projection="EPSG:3857")
fig, ax = plot_choropleth(gdf, value="value_column", layout=layout)
CLI with classification and top legend
chorokit data.geojson value_column \
--scheme quantiles -k 5 \
--legend-location top --legend-title "value per 100k"
ColorBrewer palettes
# 7-class Blues palette with natural breaks
chorokit us_states.geojson POPULATION --palette Blues:7 --scheme natural \
--title "US State Population" --source "Source: U.S. Census Bureau"
# 5-class Reds palette with quantile breaks
chorokit data.geojson value --palette Reds:5 --scheme quantiles
Python with ColorBrewer palettes
from chorokit import plot_choropleth, LegendConfig
legend = LegendConfig(
kind="binned",
palette=("Reds", 5),
scheme="quantiles",
title="Population density",
)
fig, ax = plot_choropleth(gdf, value="density", legend=legend)
Real-world example
import geopandas as gpd
from chorokit import plot_choropleth, LegendConfig, LayoutConfig
gdf = gpd.read_file("demographics.geojson")
legend = LegendConfig(
kind="binned",
title="Percent of population, by block",
breaks=[0, 5, 15, 30, 50, 90],
labels=["0", "5", "15", "30", "50", "90"],
)
layout = LayoutConfig(
title="Percent non-Hispanic Asian",
subtitle="Los Angeles County blocks, 2020",
source="Source: County of Los Angeles, Census 2020",
width=10,
)
fig, ax = plot_choropleth(gdf, value="pc_nh_asn", cmap="Reds", legend=legend, layout=layout)
Census of Agriculture (county overlays)
python examples/ag_census_maps.py
Joins tidy county CSVs to US boundaries (cached under examples/data/raw/ on first
run) and draws three CONUS maps that use state-boundary overlays, log + nice-round
breaks, compact/% legend labels, a left-aligned legend and a No-data swatch.
Features
- Layout: figure height comes from the map aspect plus fixed-size title, legend and source bands, so spacing is identical for wide, tall or square geographies
- Projection: auto-projects geographic data. Local/regional extents use a suitable UTM zone; large CONUS extents use EPSG:5070. You can pass an explicit CRS via int, EPSG string or
pyproj.CRS. - Legend: top or bottom placement (always horizontal); left or center align; binned or continuous; auto breaks via
schemeandk; optional log classification and nice-round edges; interval or boundary labels with compactk/M/%formatting; automatic No-data swatch - Overlays: pass
Overlaylayers (state lines, etc.) drawn on top of the fill - ColorBrewer palettes: access to ColorBrewer 2.0 sequential, diverging and qualitative color schemes with discrete class counts
- Theme: Barlow ships with the package for consistent typography; override via
LayoutConfig.theme - CLI: flags for projection, legend options and auto classification
Development
pip install -e ".[dev]"
pytest # unit + image comparison tests
python tools/gallery.py # contact sheet across the case matrix
Regenerate image baselines after intentional layout changes:
pytest tests/test_visual.py --mpl-generate-path=tests/baseline
ColorBrewer attribution
ColorBrewer color specifications and designs were developed by Cynthia Brewer (https://colorbrewer2.org/). Please see the ColorBrewer Apache-Style license.
Copyright 2002 Cynthia Brewer, Mark Harrower, and The Pennsylvania State University
License
MIT
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file chorokit-0.2.0.tar.gz.
File metadata
- Download URL: chorokit-0.2.0.tar.gz
- Upload date:
- Size: 10.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bd837514b3cc8f0dc1420f1da91402e9991fde406e2c439ccc0f5a48d63b1c92
|
|
| MD5 |
17b52c480055fcbe5f1e5a4116632346
|
|
| BLAKE2b-256 |
3f6664097c7a750d2b7a8d79a8e4ad9d1670de33f94036467078336dee622397
|
File details
Details for the file chorokit-0.2.0-py3-none-any.whl.
File metadata
- Download URL: chorokit-0.2.0-py3-none-any.whl
- Upload date:
- Size: 179.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7f539a0892304761c2e5838595a585276db839db5f1361154ec25c7030d8ada9
|
|
| MD5 |
384f0ff600c3ced48d3a5b41bd5c2027
|
|
| BLAKE2b-256 |
ef9da033d604382f24878a6fdcab0957f49ffef19f769150a14494ebbe63a911
|