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
Metadata
Release files for chorokit 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| chorokit-0.2.0.tar.gz | 10.4 MB | Without provenance | Details for chorokit-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| chorokit-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for chorokit-0.2.0-py3-none-any.whl |
Total release size: 10.5 MB
Release files / chorokit-0.2.0.tar.gz
| Download URL | chorokit-0.2.0.tar.gz |
|---|---|
| Size | 10.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bd837514b3cc8f0dc1420f1da91402e9991fde406e2c439ccc0f5a48d63b1c92
|
|
BLAKE2b-256 checksum How to use checksums |
3f6664097c7a750d2b7a8d79a8e4ad9d1670de33f94036467078336dee622397
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.14
|
Release files / chorokit-0.2.0-py3-none-any.whl
| Download URL | chorokit-0.2.0-py3-none-any.whl |
|---|---|
| Size | 179.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7f539a0892304761c2e5838595a585276db839db5f1361154ec25c7030d8ada9
|
|
BLAKE2b-256 checksum How to use checksums |
ef9da033d604382f24878a6fdcab0957f49ffef19f769150a14494ebbe63a911
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.14
|
Security for chorokit 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.