Meta tags:
description= Fast static image export for web-based visualization libraries - plotly/kaleido;
Headings (most frequently used words):
navigation, repository, about, files, by, footer, resources, code, of, conduct, stars, watchers, forks, overview, menu, latest, commit, history, folders, and, installation, migrating, from, v0, to, v1, development, guide, releases, packages, used, contributors, languages, usage, examples, generate, multiple, images, faster, reusing, the, same, chrome, instance, pagegenerators,
Text of the page (most frequently used words):
#kaleido (43), plotly (24), you (19), for (18), and (18), github (15), the (15), chrome (14), code (13), fig (13), import (10), your (9), can (7), are (7), repository (6), all (6), path (6), with (6), security (5), conduct (5), license (5), readme (5), image (5), version (5), call (5), figure (5), write_fig (5), changelog (5), navigation (4), used (4), forks (4), stars (4), 505 (4), static (4), export (4), based (4), installed (4), use (4), python (4), figures (4), images (4), asyncio (4), arguments (4), opts (4), see (4), install (4), using (4), signed (4), support (4), copilot (4), not (3), mit (3), resources (3), fast (3), web (3), visualization (3), libraries (3), about (3), other (3), script (3), false (3), file (3), pagegenerator (3), which (3), default (3), release (3), png (3), write_image (3), one (3), single (3), instance (3), will (3), write_fig_sync (3), optional (3), format (3), library (3), main (3), fig_objects (3), jpg (3), scatter (3), directly (3), documentation (3), installation (3), need (3), more (3), files (3), commit (3), actions (3), quality (3), another (3), tab (3), window (3), refresh (3), session (3), reload (3), sign (3), developers (3), customer (3), enterprise (3), grade (3), features (3), build (3), that (2), time (2), community (2), status (2), footer (2), report (2), watching (2), watchers (2), custom (2), properties (2), activity (2), fully (2), qualified (2), link (2), mathjax (2), https (2), cdn (2), customize (2), when (2), generating (2), pass (2), true (2), page_generator (2), pagegenerators (2), running (2), fig_ (2), start_sync_server (2), graph_objects (2), across (2), each (2), renders (2), exporting (2), generate (2), kopts (2), run (2), timeout (2), functions (2), object (2), iterable (2), change (2), below (2), write_fig_from_object (2), await (2), also (2), where (2), async (2), examples (2), instructions (2), development (2), provides (2), have (2), from (2), kaleido_get_chrome (2), pip (2), platform (2), items (2), code_of_conduct (2), markdown (2), gitignore (2), src (2), workflows (2), last (2), message (2), name (2), 152 (2), commits (2), latest (2), menu (2), must (2), star (2), settings (2), insights (2), projects (2), universe (2), training (2), integrations (2), stories (2), center (2), learn (2), business (2), fixes (2), products (2), secret (2), perform, action, this, share, personal, information, manage, cookies, contact, docs, privacy, terms, 2026, inc, languages, contributors, packages, releases, list, links, include, others, disable, plot, my_page, argument, takes, versions, scripts, defaults, contained, package, force, behavior, force_cdn, closed, automatically, exits, sooner, example, long, service, jupyter, kernel, explicitly, stop_sync_server, enumerate, stays, warm, once, top, start, reuse, subsequent, sync, calls, including, launches, fresh, shuts, down, again, many, per, startup, shutdown, delay, dominate, runtime, calc_fig_sync, multiple, faster, reusing, same, constructor, via, there, shortcut, without, creating, remaining, cancelled, first, error, raised, immediately, any, returned, tuple, after, attempted, cancel_on_error, errors, during, rendering, collected, scale, width, height, dictionary, options, directory, names, auto, generated, title, required, range, topojson, dicts, expanded, number, processes, def, express, usage, want, charts, necessary, how, program, guide, data, uses, has, been, removed, scopes, longer, included, look, existing, but, commands, installing, don, section, above, later, introduces, new, api, currently, make, changes, environment, migrating, get_chrome_sync, function, requires, already, system, should, find, otherwise, compatible, command, upgrade, pypi, cross, svg, pdf, etc, overview, view, date, folders, history, open, tags, branches, fork, notification, notifications, public, wiki, pull, requests, issues, dismiss, alert, switched, accounts, out, appearance, search, pricing, event, talks, workshops, what, next, partners, company, forum, events, webinars, blog, resource, connect, premium, advanced, add, ons, trust, why, evaluate, industries, government, manufacturing, financial, services, healthcare, industry, nonprofits, startups, team, enterprises, stage, businesses, source, improvements, place, developer, articles, sponsors, trending, repos, explore, certifications, scanning, leak, prevention, protection, vulnerability, detection, remediation, secure, cloud, environments, codespaces, analysis, enforcement, automation, ship, coding, agent, tasks, automated, work, hosting, review, collaboration, skip, content,
Text of the page (random words):
github plotly kaleido fast static image export for web based visualization libraries github skip to content navigation menu sign in products platform github repository hosting code review and collaboration copilot ai coding agent for tasks projects and automated work build ship actions ci cd and automation code quality quality analysis fixes and enforcement codespaces cloud development environments secure code security vulnerability detection and remediation secret protection secret scanning and leak prevention all features developers learn documentation training certifications build build with copilot customize copilot integrations explore trending repos github sponsors developer articles changelog changelog your source for the latest features improvements and fixes across github products all in one place businesses by stage enterprises team startups nonprofits by industry healthcare financial services manufacturing government see all industries evaluate github why github customer stories business insights trust center add ons github advanced security enterprise grade code security copilot for business enterprise grade ai features premium support enterprise grade 24 7 support resources learn connect documentation resource center blog events webinars community forum customer stories integrations support customer support training github status company about partners changelog github universe github universe the event for developers by developers talks workshops and what s next for github pricing search sign in sign up appearance settings you signed in with another tab or window reload to refresh your session you signed out in another tab or window reload to refresh your session you switched accounts on another tab or window reload to refresh your session dismiss alert message plotly kaleido repository navigation code issues 51 51 pull requests 17 17 actions projects wiki security and quality insights more items kaleido public notifications you must be signed in to change notification settings fork 65 65 star 505 505 you must be signed in to star a repository about fast static image export for web based visualization libraries resources readme mit license code of conduct code of conduct activity custom properties stars 505 stars watchers 10 watching forks 65 forks report repository main branches tags go to file code open more actions menu latest commit history 1 152 commits 1 152 commits folders and files name name last commit message last commit date github workflows github workflows src src gitignore gitignore markdown rb markdown rb changelog md changelog md code_of_conduct md code_of_conduct md license license readme md readme md release md release md view all files repository files navigation readme code of conduct mit license more items overview kaleido is a cross platform python library for generating static images e g png svg pdf etc for plotly js to be used by plotly py installation kaleido can be installed from pypi using pip pip install kaleido upgrade as of version 1 0 0 kaleido requires chrome to be installed if you already have chrome on your system kaleido should find it otherwise you can install a compatible chrome version using the kaleido_get_chrome command kaleido_get_chrome or function in python import kaleido kaleido get_chrome_sync migrating from v0 to v1 kaleido v1 introduces a new api if you re currently using v0 you ll need to make changes to your code and environment where you are running kaleido if using kaleido v1 with plotly py you will need to install plotly py v6 1 1 or later chrome is no longer included with kaleido kaleido will look for an existing chrome installation but also provides commands for installing chrome if you don t have chrome you ll need to install it see the installation section above for instructions if your code uses kaleido directly kaleido scopes plotly has been removed in v1 kaleido v1 provides write_fig and write_fig_sync for exporting plotly figures import kaleido import plotly graph_objects as go fig go figure data go scatter y 1 3 2 kaleido write_fig_sync fig path figure png development guide below are examples of how to use kaleido directly in your python program if you want to export images of plotly charts it s not necessary to call kaleido directly you can use functions in the plotly library see the plotly documentation for instructions usage examples import asyncio import kaleido import plotly express as px async def main n is number of processes async with kaleido kaleido n 4 timeout 90 as k fig is a plotly figure object fig px scatter x 1 2 3 4 y 2 1 4 3 await k write_fig fig path opts format jpg you can also use kaleido write_fig_from_object where fig_objects is an iterable of dicts each expanded to the write_fig arguments fig path opts topojson fig_objects fig px scatter x 1 2 3 4 y 2 i 1 i 4 i 3 i path f fig_ i jpg opts format jpg for i in range 10 await k write_fig_from_object fig_objects asyncio run main other kaleido kaleido arguments page_generator change library version see pagegenerators below kaleido write_fig arguments fig required a single plotly figure or an iterable path optional a directory names auto generated based on title or a single file opts optional a dictionary with image options scale format width height cancel_on_error optional if false default errors during rendering are collected and returned as a tuple after all figures are attempted if true the first error is raised immediately and any remaining renders are cancelled there are shortcut functions which can be used to generate images without creating a kaleido object import asyncio import kaleido pass kaleido constructor arguments e g n timeout via kopts asyncio run kaleido write_fig fig path kopts n 4 generate multiple images faster by reusing the same chrome instance by default each call to kaleido write_fig_sync kaleido calc_fig_sync or plotly s fig write_image launches a fresh chrome instance renders the figure and shuts chrome down again if you re exporting many figures in one script the per call chrome startup and shutdown delay will dominate runtime call kaleido start_sync_server once at the top of your script to start a single chrome instance and reuse it across all subsequent sync calls including fig write_image import kaleido import plotly graph_objects as go kaleido start_sync_server one time chrome stays warm for i fig in enumerate figures fig write_image f fig_ i png chrome is closed automatically when python exits to release it sooner for example in a long running service or jupyter kernel call kaleido stop_sync_server explicitly pagegenerators the page_generator argument takes a kaleido pagegenerator to customize which versions of plotly js mathjax and other scripts are used when generating an image if plotly is installed kaleido defaults to the version of plotly js contained in that package you can pass kaleido pagegenerator force_cdn true to force use of a cdn version of plotly which is the default behavior if plotly is not installed my_page kaleido pagegenerator plotly https cdn plot ly plotly 3 7 0 js a fully qualified https or file link mathjax false false to disable or a fully qualified link others a list of other script links to include about fast static image export for web based visualization libraries resources readme mit license code of conduct code of conduct activity custom properties stars 505 stars watchers 10 watching forks 65 forks report repository releases packages used by contributors languages footer 2026 github inc footer navigation terms privacy security status community docs contact manage cookies do not share my personal information you can t perform that action at this time
|