Python interface to generate executable Typst code.

Project description

typstpy

Introduction

typstpy is a python package for generating executable typst codes. This package is written primarily in functional programming paradigm with some OOP contents. Each module in this package has greater than 90% unit test coverage.

This package provides interfaces which are as close as possible to typst's native functions. Through typstpy and other data processing packages, you can generate data report instantly.

Repository on GitHub: python-typst. Homepage on PyPI: python-typst. Any contributions are welcome.

Change logs

1.4.0-alpha.0:
- Improve internal series spread handling for single children.
- Use explicit exceptions instead of assertions for public argument validation.
- Fix import_ without names and show_(None, ...) rendering.
- Refactor: add render_content() to IR protocol, removing fragile strip_brace char slicing.
- Refactor: extract _make_where_func / _make_with_func from implement decorator.
- Clarify spread logic: split _should_spread_single_child into dedicated helpers.
- Add missing Raises: sections to docstrings across std modules.
- Migrate type annotations to Python 3.10+ union syntax (X | None etc.).
- Add UP (pyupgrade) to ruff lint ruleset.
- Add call_ factory function to customizations module.
1.3.0:
- Support for typst version: 0.14.2.
1.2.1:
- Clear type annotations.
- Improved support for the typst 0.13.1 version.
1.2.0:
- Support for typst version: 0.13.x.
- Migrate set_, show_ and import_ to typstpy.std module.
1.1.1:
- Fix: Fix the behavior of with_.
1.1.0: Provide customizations module to support custom functions.
1.0.4: Implement package subpar.
1.0.3:
- Fix: Fix the behavior of show_.
- Compatibility: The parameters' order of show_ is flipped compared to previous version.
1.0.2: Improved type annotations.
1.0.1: Implement set, show, and import.
1.0.0: Completed documentation and test cases in layout, model, text and visualize modules. Improved functionality.
1.0.0-beta.2: Improved the implementation and documentation of functions in the layout module.
1.0.0-beta.1: Completely reconstructed the underlying implementation.

Installation

pip install typstpy

How to customize?

typstpy provides the customizations module to support defining functions that are not yet supported in typstpy. The examples are:

>>> from typstpy.customizations import *
>>> pad = normal('pad')
>>> pad(
...     '[Hello, world!]',
...     left='4% + 0pt',
...     top='4% + 0pt',
...     right='4% + 0pt',
...     bottom='4% + 0pt',
... )
'#pad([Hello, world!], left: 4% + 0pt, top: 4% + 0pt, right: 4% + 0pt, bottom: 4% + 0pt)'
>>> pagebreak = normal('pagebreak')
>>> pagebreak(weak=True)
'#pagebreak(weak: true)'
>>> rgb = positional('rgb')
>>> color_lighten = instance('lighten')
>>> color_lighten(rgb(255, 255, 255), '50%')
'#rgb(255, 255, 255).lighten(50%)'
>>> rgb = positional('rgb')
>>> rgb(255, 255, 255, '50%')
'#rgb(255, 255, 255, 50%)'
>>> table = post_series('table')
>>> table(
...     '[1]',
...     '[2]',
...     '[3]',
...     columns=['1fr', '2fr', '3fr'],
...     rows=['1fr', '2fr', '3fr'],
...     gutter=['1fr', '2fr', '3fr'],
...     column_gutter=['1fr', '2fr', '3fr'],
...     row_gutter=['1fr', '2fr', '3fr'],
...     fill='red',
...     align=['center', 'center', 'center'],
... )
'#table(columns: (1fr, 2fr, 3fr), rows: (1fr, 2fr, 3fr), gutter: (1fr, 2fr, 3fr), column-gutter: (1fr, 2fr, 3fr), row-gutter: (1fr, 2fr, 3fr), fill: red, align: (center, center, center), [1], [2], [3])'
>>> subpar_grid = pre_series('subpar.grid')
>>> subpar_grid(
...     '[]',
...     '[]',
...     columns=('1fr', '1fr'),
...     caption='[A figure composed of two sub figures.]',
...     label='<full>',
... )
'#subpar.grid([], [], columns: (1fr, 1fr), caption: [A figure composed of two sub figures.], label: <full>)'

Current Supports

Package's function name	Typst's function name	Documentation on typst	Version
std.align	align	https://typst.app/docs/reference/layout/align/	0.14.2
std.bibliography	bibliography	https://typst.app/docs/reference/model/bibliography/	0.14.2
std.block	block	https://typst.app/docs/reference/layout/block/	0.14.2
std.box	box	https://typst.app/docs/reference/layout/box/	0.14.2
std.bullet_list	list	https://typst.app/docs/reference/model/list/	0.14.2
std.bullet_list.item	list.item	https://typst.app/docs/reference/model/list/#definitions-item	0.14.2
std.circle	circle	https://typst.app/docs/reference/visualize/circle/	0.14.2
std.cite	cite	https://typst.app/docs/reference/model/cite/	0.14.2
std.cmyk	cmyk	https://typst.app/docs/reference/visualize/color/#definitions-cmyk	0.14.2
std.colbreak	colbreak	https://typst.app/docs/reference/layout/colbreak/	0.14.2
std.color	color	https://typst.app/docs/reference/visualize/color/	0.14.2
std.color.components	components	https://typst.app/docs/reference/visualize/color/#definitions-components	0.14.2
std.color.darken	darken	https://typst.app/docs/reference/visualize/color/#definitions-darken	0.14.2
std.color.desaturate	desaturate	https://typst.app/docs/reference/visualize/color/#definitions-desaturate	0.14.2
std.color.hsl	color.hsl	https://typst.app/docs/reference/visualize/color/#definitions-hsl	0.14.2
std.color.hsv	color.hsv	https://typst.app/docs/reference/visualize/color/#definitions-hsv	0.14.2
std.color.lighten	lighten	https://typst.app/docs/reference/visualize/color/#definitions-lighten	0.14.2
std.color.linear_rgb	color.linear-rgb	https://typst.app/docs/reference/visualize/color/#definitions-linear-rgb	0.14.2
std.color.map	color.map	https://typst.app/docs/reference/visualize/color/#predefined-color-maps	0.14.2
std.color.mix	color.mix	https://typst.app/docs/reference/visualize/color/#definitions-mix	0.14.2
std.color.negate	negate	https://typst.app/docs/reference/visualize/color/#definitions-negate	0.14.2
std.color.opacify	opacify	https://typst.app/docs/reference/visualize/color/#definitions-opacify	0.14.2
std.color.rotate	rotate	https://typst.app/docs/reference/visualize/color/#definitions-rotate	0.14.2
std.color.saturate	saturate	https://typst.app/docs/reference/visualize/color/#definitions-saturate	0.14.2
std.color.space	space	https://typst.app/docs/reference/visualize/color/#definitions-space	0.14.2
std.color.to_hex	to-hex	https://typst.app/docs/reference/visualize/color/#definitions-to-hex	0.14.2
std.color.transparentize	transparentize	https://typst.app/docs/reference/visualize/color/#definitions-transparentize	0.14.2
std.columns	columns	https://typst.app/docs/reference/layout/columns/	0.14.2
std.curve	curve	https://typst.app/docs/reference/visualize/curve/	0.14.2
std.curve.close	curve.close	https://typst.app/docs/reference/visualize/curve/#definitions-close	0.14.2
std.curve.cubic	curve.cubic	https://typst.app/docs/reference/visualize/curve/#definitions-cubic	0.14.2
std.curve.line	curve.line	https://typst.app/docs/reference/visualize/curve/#definitions-line	0.14.2
std.curve.move	curve.move	https://typst.app/docs/reference/visualize/curve/#definitions-move	0.14.2
std.curve.quad	curve.quad	https://typst.app/docs/reference/visualize/curve/#definitions-quad	0.14.2
std.document	document	https://typst.app/docs/reference/model/document/	0.14.2
std.ellipse	ellipse	https://typst.app/docs/reference/visualize/ellipse/	0.14.2
std.emph	emph	https://typst.app/docs/reference/model/emph/	0.14.2
std.figure	figure	https://typst.app/docs/reference/model/figure/	0.14.2
std.figure.caption	figure.caption	https://typst.app/docs/reference/model/figure/#definitions-caption	0.14.2
std.footnote	footnote	https://typst.app/docs/reference/model/footnote/	0.14.2
std.footnote.entry	footnote.entry	https://typst.app/docs/reference/model/footnote/#definitions-entry	0.14.2
std.gradient	gradient	https://typst.app/docs/reference/visualize/gradient/	0.14.2
std.gradient.angle	angle	https://typst.app/docs/reference/visualize/gradient/#definitions-angle	0.14.2
std.gradient.center	center	https://typst.app/docs/reference/visualize/gradient/#definitions-center	0.14.2
std.gradient.conic	gradient.conic	https://typst.app/docs/reference/visualize/gradient/#definitions-conic	0.14.2
std.gradient.focal_center	focal-center	https://typst.app/docs/reference/visualize/gradient/#definitions-focal-center	0.14.2
std.gradient.focal_radius	focal-radius	https://typst.app/docs/reference/visualize/gradient/#definitions-focal-radius	0.14.2
std.gradient.kind	kind	https://typst.app/docs/reference/visualize/gradient/#definitions-kind	0.14.2
std.gradient.linear	gradient.linear	https://typst.app/docs/reference/visualize/gradient/#definitions-linear	0.14.2
std.gradient.radial	gradient.radial	https://typst.app/docs/reference/visualize/gradient/#definitions-radial	0.14.2
std.gradient.radius	radius	https://typst.app/docs/reference/visualize/gradient/#definitions-radius	0.14.2
std.gradient.relative	relative	https://typst.app/docs/reference/visualize/gradient/#definitions-relative	0.14.2
std.gradient.repeat	repeat	https://typst.app/docs/reference/visualize/gradient/#definitions-repeat	0.14.2
std.gradient.sample	sample	https://typst.app/docs/reference/visualize/gradient/#definitions-sample	0.14.2
std.gradient.samples	samples	https://typst.app/docs/reference/visualize/gradient/#definitions-samples	0.14.2
std.gradient.sharp	sharp	https://typst.app/docs/reference/visualize/gradient/#definitions-sharp	0.14.2
std.gradient.space	space	https://typst.app/docs/reference/visualize/gradient/#definitions-space	0.14.2
std.gradient.stops	stops	https://typst.app/docs/reference/visualize/gradient/#definitions-stops	0.14.2
std.grid	grid	https://typst.app/docs/reference/layout/grid/	0.14.2
std.grid.cell	grid.cell	https://typst.app/docs/reference/layout/grid/#definitions-cell	0.14.2
std.grid.footer	grid.footer	https://typst.app/docs/reference/layout/grid/#definitions-footer	0.14.2
std.grid.header	grid.header	https://typst.app/docs/reference/layout/grid/#definitions-header	0.14.2
std.grid.hline	grid.hline	https://typst.app/docs/reference/layout/grid/#definitions-hline	0.14.2
std.grid.vline	grid.vline	https://typst.app/docs/reference/layout/grid/#definitions-vline	0.14.2
std.heading	heading	https://typst.app/docs/reference/model/heading/	0.14.2
std.hide	hide	https://typst.app/docs/reference/layout/hide/	0.14.2
std.highlight	highlight	https://typst.app/docs/reference/text/highlight/	0.14.2
std.hspace	h	https://typst.app/docs/reference/layout/h/	0.14.2
std.image	image	https://typst.app/docs/reference/visualize/image/	0.14.2
std.layout	layout	https://typst.app/docs/reference/layout/layout/	0.14.2
std.line	line	https://typst.app/docs/reference/visualize/line/	0.14.2
std.linebreak	linebreak	https://typst.app/docs/reference/text/linebreak/	0.14.2
std.link	link	https://typst.app/docs/reference/model/link/	0.14.2
std.lorem	lorem	https://typst.app/docs/reference/text/lorem/	0.14.2
std.lower	lower	https://typst.app/docs/reference/text/lower/	0.14.2
std.luma	luma	https://typst.app/docs/reference/visualize/color/#definitions-luma	0.14.2
std.measure	measure	https://typst.app/docs/reference/layout/measure/	0.14.2
std.move	move	https://typst.app/docs/reference/layout/move/	0.14.2
std.numbered_list	enum	https://typst.app/docs/reference/model/enum/	0.14.2
std.numbered_list.item	enum.item	https://typst.app/docs/reference/model/enum/#definitions-item	0.14.2
std.numbering	numbering	https://typst.app/docs/reference/model/numbering/	0.14.2
std.oklab	oklab	https://typst.app/docs/reference/visualize/color/#definitions-oklab	0.14.2
std.oklch	oklch	https://typst.app/docs/reference/visualize/color/#definitions-oklch	0.14.2
std.outline	outline	https://typst.app/docs/reference/model/outline/	0.14.2
std.outline.body	body	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-body	0.14.2
std.outline.entry	outline.entry	https://typst.app/docs/reference/model/outline/#definitions-entry	0.14.2
std.outline.indented	indented	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-indented	0.14.2
std.outline.inner	inner	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-inner	0.14.2
std.outline.page	page	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-page	0.14.2
std.outline.prefix	prefix	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-prefix	0.14.2
std.overline	overline	https://typst.app/docs/reference/text/overline/	0.14.2
std.pad	pad	https://typst.app/docs/reference/layout/pad/	0.14.2
std.page	page	https://typst.app/docs/reference/layout/page/	0.14.2
std.pagebreak	pagebreak	https://typst.app/docs/reference/layout/pagebreak/	0.14.2
std.par	par	https://typst.app/docs/reference/model/par/	0.14.2
std.par.line	par.line	https://typst.app/docs/reference/model/par/#definitions-line	0.14.2
std.parbreak	parbreak	https://typst.app/docs/reference/model/parbreak/	0.14.2
std.place	place	https://typst.app/docs/reference/layout/place/	0.14.2
std.place.flush	place.flush	https://typst.app/docs/reference/layout/place/#definitions-flush	0.14.2
std.polygon	polygon	https://typst.app/docs/reference/visualize/polygon/	0.14.2
std.polygon.regular	polygon.regular	https://typst.app/docs/reference/visualize/polygon/#definitions-regular	0.14.2
std.quote	quote	https://typst.app/docs/reference/model/quote/	0.14.2
std.raw	raw	https://typst.app/docs/reference/text/raw/	0.14.2
std.raw.line	raw.line	https://typst.app/docs/reference/text/raw/#definitions-line	0.14.2
std.rect	rect	https://typst.app/docs/reference/visualize/rect/	0.14.2
std.ref	ref	https://typst.app/docs/reference/model/ref/	0.14.2
std.repeat	repeat	https://typst.app/docs/reference/layout/repeat/	0.14.2
std.rgb	rgb	https://typst.app/docs/reference/visualize/color/#definitions-rgb	0.14.2
std.rotate	rotate	https://typst.app/docs/reference/layout/rotate/	0.14.2
std.scale	scale	https://typst.app/docs/reference/layout/scale/	0.14.2
std.skew	skew	https://typst.app/docs/reference/layout/skew/	0.14.2
std.smallcaps	smallcaps	https://typst.app/docs/reference/text/smallcaps/	0.14.2
std.smartquote	smartquote	https://typst.app/docs/reference/text/smartquote/	0.14.2
std.square	square	https://typst.app/docs/reference/visualize/square/	0.14.2
std.stack	stack	https://typst.app/docs/reference/layout/stack/	0.14.2
std.strike	strike	https://typst.app/docs/reference/text/strike/	0.14.2
std.strong	strong	https://typst.app/docs/reference/model/strong/	0.14.2
std.subscript	sub	https://typst.app/docs/reference/text/sub/	0.14.2
std.superscript	super	https://typst.app/docs/reference/text/super/	0.14.2
std.table	table	https://typst.app/docs/reference/model/table/	0.14.2
std.table.cell	table.cell	https://typst.app/docs/reference/model/table/#definitions-cell	0.14.2
std.table.footer	table.footer	https://typst.app/docs/reference/model/table/#definitions-footer	0.14.2
std.table.header	table.header	https://typst.app/docs/reference/model/table/#definitions-header	0.14.2
std.table.hline	table.hline	https://typst.app/docs/reference/model/table/#definitions-hline	0.14.2
std.table.vline	table.vline	https://typst.app/docs/reference/model/table/#definitions-vline	0.14.2
std.terms	terms	https://typst.app/docs/reference/model/terms/	0.14.2
std.terms.item	terms.item	https://typst.app/docs/reference/model/terms/#definitions-item	0.14.2
std.text	text	https://typst.app/docs/reference/text/text/	0.14.2
std.tiling	tiling	https://typst.app/docs/reference/visualize/tiling/	0.14.2
std.title	title	https://typst.app/docs/reference/model/title/	0.14.2
std.underline	underline	https://typst.app/docs/reference/text/underline/	0.14.2
std.upper	upper	https://typst.app/docs/reference/text/upper/	0.14.2
std.visualize._image_decode	image.decode	https://typst.app/docs/reference/visualize/image/#definitions-decode	0.14.2
std.visualize.path	path	https://typst.app/docs/reference/visualize/path/	0.14.2
std.visualize.pattern	pattern	https://typst.app/docs/reference/visualize/tiling/#compatibility	0.14.2
std.vspace	v	https://typst.app/docs/reference/layout/v/	0.14.2
subpar.grid	subpar.grid	https://typst.app/universe/package/subpar	None

Examples

std.align:

>>> align('"Hello, World!"', 'center')
'#align(center, "Hello, World!")'
>>> align('[Hello, World!]', 'center')
'#align(center, [Hello, World!])'
>>> align(lorem(20), 'center')
'#align(center, lorem(20))'

std.bibliography:

>>> bibliography('"bibliography.bib"', style='"cell"')
'#bibliography("bibliography.bib", style: "cell")'

std.block:

>>> block('"Hello, World!"')
'#block("Hello, World!")'
>>> block('[Hello, World!]')
'#block([Hello, World!])'
>>> block(lorem(20))
'#block(lorem(20))'
>>> block(lorem(20), width='100%')
'#block(lorem(20), width: 100%)'

std.box:

>>> box('"Hello, World!"')
'#box("Hello, World!")'
>>> box('[Hello, World!]')
'#box([Hello, World!])'
>>> box(lorem(20))
'#box(lorem(20))'
>>> box(lorem(20), width='100%')
'#box(lorem(20), width: 100%)'

std.bullet_list:

>>> bullet_list(lorem(20), lorem(20), lorem(20))
'#list(lorem(20), lorem(20), lorem(20))'
>>> bullet_list(lorem(20), lorem(20), lorem(20), tight=False)
'#list(tight: false, lorem(20), lorem(20), lorem(20))'

std.bullet_list.item:

>>> bullet_list.item('[Hello, World!]')
'#list.item([Hello, World!])'

std.circle:

>>> circle('[Hello, world!]')
'#circle([Hello, world!])'
>>> circle('[Hello, world!]', radius='10pt')
'#circle([Hello, world!], radius: 10pt)'
>>> circle('[Hello, world!]', width='100%')
'#circle([Hello, world!], width: 100%)'

std.cite:

>>> cite('<label>')
'#cite(<label>)'
>>> cite('<label>', supplement='[Hello, World!]')
'#cite(<label>, supplement: [Hello, World!])'
>>> cite('<label>', form='"prose"')
'#cite(<label>, form: "prose")'
>>> cite('<label>', style='"annual-reviews"')
'#cite(<label>, style: "annual-reviews")'

std.cmyk:

>>> cmyk('0%', '0%', '0%', '0%')
'#cmyk(0%, 0%, 0%, 0%)'
>>> cmyk('50%', '50%', '50%', '50%')
'#cmyk(50%, 50%, 50%, 50%)'

std.colbreak:

>>> colbreak()
'#colbreak()'
>>> colbreak(weak=True)
'#colbreak(weak: true)'

std.color:

>>> color()
'#color'

std.color.components:

>>> color.components(rgb(255, 255, 255))
'#rgb(255, 255, 255).components()'

std.color.darken:

>>> color.darken(rgb(255, 255, 255), '50%')
'#rgb(255, 255, 255).darken(50%)'

std.color.desaturate:

>>> color.desaturate(rgb(255, 255, 255), '50%')
'#rgb(255, 255, 255).desaturate(50%)'

std.color.hsl:

>>> color.hsl('0deg', '50%', '50%', '50%')
'#color.hsl(0deg, 50%, 50%, 50%)'
>>> color.hsl('0deg', '50%', '50%')
'#color.hsl(0deg, 50%, 50%)'

std.color.hsv:

>>> color.hsv('0deg', '50%', '50%', '50%')
'#color.hsv(0deg, 50%, 50%, 50%)'
>>> color.hsv('0deg', '50%', '50%')
'#color.hsv(0deg, 50%, 50%)'

std.color.lighten:

>>> color.lighten(rgb(255, 255, 255), '50%')
'#rgb(255, 255, 255).lighten(50%)'

std.color.linear_rgb:

>>> color.linear_rgb(255, 255, 255)
'#color.linear-rgb(255, 255, 255)'
>>> color.linear_rgb('50%', '50%', '50%', '50%')
'#color.linear-rgb(50%, 50%, 50%, 50%)'

std.color.map:

>>> color.map('turbo')
'#color.map.turbo'

std.color.mix:

>>> color.mix(rgb(255, 255, 255), rgb(0, 0, 0), space='oklch')
'#color.mix(rgb(255, 255, 255), rgb(0, 0, 0), space: oklch)'

std.color.negate:

>>> color.negate(rgb(255, 255, 255))
'#rgb(255, 255, 255).negate()'
>>> color.negate(rgb(255, 255, 255), space='oklch')
'#rgb(255, 255, 255).negate(space: oklch)'

std.color.opacify:

>>> color.opacify(rgb(255, 255, 255), '50%')
'#rgb(255, 255, 255).opacify(50%)'

std.color.rotate:

>>> color.rotate(rgb(255, 255, 255), '90deg')
'#rgb(255, 255, 255).rotate(90deg)'

std.color.saturate:

>>> color.saturate(rgb(255, 255, 255), '50%')
'#rgb(255, 255, 255).saturate(50%)'

std.color.space:

>>> color.space(rgb(255, 255, 255))
'#rgb(255, 255, 255).space()'

std.color.to_hex:

>>> color.to_hex(rgb(255, 255, 255))
'#rgb(255, 255, 255).to-hex()'

std.color.transparentize:

>>> color.transparentize(rgb(255, 255, 255), '50%')
'#rgb(255, 255, 255).transparentize(50%)'

std.columns:

>>> columns(lorem(20))
'#columns(lorem(20))'
>>> columns(lorem(20), 3)
'#columns(3, lorem(20))'
>>> columns(lorem(20), 3, gutter='8% + 0pt')
'#columns(3, lorem(20), gutter: 8% + 0pt)'

std.curve:

>>> curve(
...     curve.move(('0pt', '50pt')),
...     curve.line(('100pt', '50pt')),
...     curve.cubic(None, ('90pt', '0pt'), ('50pt', '0pt')),
...     curve.close(),
...     stroke='blue',
... )
'#curve(stroke: blue, curve.move((0pt, 50pt)), curve.line((100pt, 50pt)), curve.cubic(none, (90pt, 0pt), (50pt, 0pt)), curve.close())'

std.curve.close:

>>> curve.close(mode='"smooth"')
'#curve.close()'
>>> curve.close(mode='"straight"')
'#curve.close(mode: "straight")'

std.curve.cubic:

>>> curve.cubic(('10pt', '10pt'), ('20pt', '20pt'), ('30pt', '30pt'))
'#curve.cubic((10pt, 10pt), (20pt, 20pt), (30pt, 30pt))'
>>> curve.cubic(
...     ('10pt', '10pt'), ('20pt', '20pt'), ('30pt', '30pt'), relative=True
... )
'#curve.cubic((10pt, 10pt), (20pt, 20pt), (30pt, 30pt), relative: true)'

std.curve.line:

>>> curve.line(('10pt', '10pt'))
'#curve.line((10pt, 10pt))'
>>> curve.line(('10pt', '10pt'), relative=True)
'#curve.line((10pt, 10pt), relative: true)'

std.curve.move:

>>> curve.move(('10pt', '10pt'))
'#curve.move((10pt, 10pt))'
>>> curve.move(('10pt', '10pt'), relative=True)
'#curve.move((10pt, 10pt), relative: true)'

std.curve.quad:

>>> curve.quad(('10pt', '10pt'), ('20pt', '20pt'))
'#curve.quad((10pt, 10pt), (20pt, 20pt))'
>>> curve.quad(('10pt', '10pt'), ('20pt', '20pt'), relative=True)
'#curve.quad((10pt, 10pt), (20pt, 20pt), relative: true)'

std.ellipse:

>>> ellipse('[Hello, World!]')
'#ellipse([Hello, World!])'
>>> ellipse('[Hello, World!]', width='100%')
'#ellipse([Hello, World!], width: 100%)'

std.emph:

>>> emph('"Hello, World!"')
'#emph("Hello, World!")'
>>> emph('[Hello, World!]')
'#emph([Hello, World!])'

std.figure:

>>> figure(image('"image.png"'))
'#figure(image("image.png"))'
>>> figure(image('"image.png"'), caption='[Hello, World!]')
'#figure(image("image.png"), caption: [Hello, World!])'

std.figure.caption:

>>> figure.caption('[Hello, World!]')
'#figure.caption([Hello, World!])'
>>> figure.caption('[Hello, World!]', position='top', separator='[---]')
'#figure.caption([Hello, World!], position: top, separator: [---])'

std.footnote:

>>> footnote('[Hello, World!]')
'#footnote([Hello, World!])'
>>> footnote('[Hello, World!]', numbering='"a"')
'#footnote([Hello, World!], numbering: "a")'

std.gradient:

>>> gradient()
'#gradient'

std.gradient.angle:

>>> gradient.angle(gradient.linear('red', 'blue'))
'#gradient.linear(red, blue).angle()'

std.gradient.center:

>>> gradient.center(gradient.linear('red', 'blue'))
'#gradient.linear(red, blue).center()'

std.gradient.conic:

>>> gradient.conic(color.map('viridis'), angle='90deg', center=('10%', '40%'))
'#gradient.conic(..color.map.viridis, angle: 90deg, center: (10%, 40%))'

std.gradient.focal_center:

>>> gradient.focal_center(gradient.linear('red', 'blue'))
'#gradient.linear(red, blue).focal-center()'

std.gradient.focal_radius:

>>> gradient.focal_radius(gradient.linear('red', 'blue'))
'#gradient.linear(red, blue).focal-radius()'

std.gradient.kind:

>>> gradient.kind(gradient.linear('red', 'blue'))
'#gradient.linear(red, blue).kind()'

std.gradient.linear:

>>> gradient.linear(rgb(255, 255, 255), rgb(0, 0, 0))
'#gradient.linear(rgb(255, 255, 255), rgb(0, 0, 0))'

std.gradient.radial:

>>> gradient.radial(
...     color.map('viridis'), focal_center=('10%', '40%'), focal_radius='5%'
... )
'#gradient.radial(..color.map.viridis, focal-center: (10%, 40%), focal-radius: 5%)'

std.gradient.radius:

>>> gradient.radius(gradient.linear('red', 'blue'))
'#gradient.linear(red, blue).radius()'

std.gradient.relative:

>>> gradient.relative(gradient.linear('red', 'blue'))
'#gradient.linear(red, blue).relative()'

std.gradient.repeat:

>>> gradient.repeat(gradient.radial('aqua', 'white'), 4, mirror=True)
'#gradient.radial(aqua, white).repeat(4, mirror: true)'

std.gradient.sharp:

>>> gradient.sharp(gradient.linear(color.map('rainbow')), 5, smoothness='50%')
'#gradient.linear(..color.map.rainbow).sharp(5, smoothness: 50%)'

std.gradient.space:

>>> gradient.space(gradient.linear('red', 'blue'))
'#gradient.linear(red, blue).space()'

std.gradient.stops:

>>> gradient.stops(gradient.linear('red', 'blue'))
'#gradient.linear(red, blue).stops()'

std.grid:

>>> grid(lorem(20), lorem(20), lorem(20), align=('center',) * 3)
'#grid(align: (center, center, center), lorem(20), lorem(20), lorem(20))'

std.grid.cell:

>>> grid.cell(lorem(20), x=3, y=3)
'#grid.cell(lorem(20), x: 3, y: 3)'

std.heading:

>>> heading('[Hello, World!]')
'#heading([Hello, World!])'
>>> heading('[Hello, World!]', level=1)
'#heading([Hello, World!], level: 1)'
>>> heading('[Hello, World!]', level=1, depth=2)
'#heading([Hello, World!], level: 1, depth: 2)'
>>> heading('[Hello, World!]', level=1, depth=2, offset=10)
'#heading([Hello, World!], level: 1, depth: 2, offset: 10)'
>>> heading('[Hello, World!]', level=1, depth=2, offset=10, numbering='"a"')
'#heading([Hello, World!], level: 1, depth: 2, offset: 10, numbering: "a")'
>>> heading(
...     '[Hello, World!]',
...     level=1,
...     depth=2,
...     offset=10,
...     numbering='"a"',
...     supplement='"Supplement"',
... )
'#heading([Hello, World!], level: 1, depth: 2, offset: 10, numbering: "a", supplement: "Supplement")'

std.hide:

>>> hide(lorem(20))
'#hide(lorem(20))'

std.highlight:

>>> highlight('"Hello, world!"', fill=rgb('"#ffffff"'))
'#highlight("Hello, world!", fill: rgb("#ffffff"))'
>>> highlight('"Hello, world!"', fill=rgb('"#ffffff"'), stroke=rgb('"#000000"'))
'#highlight("Hello, world!", fill: rgb("#ffffff"), stroke: rgb("#000000"))'
>>> highlight(
...     '"Hello, world!"',
...     fill=rgb('"#ffffff"'),
...     stroke=rgb('"#000000"'),
...     top_edge='"bounds"',
...     bottom_edge='"bounds"',
... )
'#highlight("Hello, world!", fill: rgb("#ffffff"), stroke: rgb("#000000"), top-edge: "bounds", bottom-edge: "bounds")'

std.hspace:

>>> hspace('1em')
'#h(1em)'
>>> hspace('1em', weak=True)
'#h(1em, weak: true)'

std.image:

>>> image('"image.png"')
'#image("image.png")'
>>> image('"image.png"', fit='"contain"')
'#image("image.png", fit: "contain")'

std.line:

>>> line()
'#line()'
>>> line(end=('100% + 0pt', '100% + 0pt'))
'#line(end: (100% + 0pt, 100% + 0pt))'
>>> line(angle='90deg')
'#line(angle: 90deg)'
>>> line(stroke='1pt + red')
'#line(stroke: 1pt + red)'

std.linebreak:

>>> linebreak()
'#linebreak()'
>>> linebreak(justify=True)
'#linebreak(justify: true)'

std.link:

>>> link('"https://typst.app"')
'#link("https://typst.app")'
>>> link('"https://typst.app"', '"Typst"')
'#link("https://typst.app", "Typst")'

std.lorem:

>>> lorem(10)
'#lorem(10)'

std.lower:

>>> lower('"Hello, World!"')
'#lower("Hello, World!")'
>>> lower('[Hello, World!]')
'#lower([Hello, World!])'
>>> lower(upper('"Hello, World!"'))
'#lower(upper("Hello, World!"))'

std.luma:

>>> luma('50%')
'#luma(50%)'
>>> luma('50%', '50%')
'#luma(50%, 50%)'

std.move:

>>> move(lorem(20), dx='50% + 10pt', dy='10% + 5pt')
'#move(lorem(20), dx: 50% + 10pt, dy: 10% + 5pt)'

std.numbered_list:

>>> numbered_list(lorem(20), lorem(20), lorem(20))
'#enum(lorem(20), lorem(20), lorem(20))'
>>> numbered_list(lorem(20), lorem(20), lorem(20), tight=False)
'#enum(tight: false, lorem(20), lorem(20), lorem(20))'

std.numbered_list.item:

>>> numbered_list.item('[Hello, World!]', number=2)
'#enum.item(2, [Hello, World!])'

std.numbering:

>>> numbering('"1.1)"', 1, 2)
'#numbering("1.1)", 1, 2)'

std.oklab:

>>> oklab('50%', '0%', '0%')
'#oklab(50%, 0%, 0%)'
>>> oklab('50%', '0%', '0%', '50%')
'#oklab(50%, 0%, 0%, 50%)'

std.oklch:

>>> oklch('50%', '0%', '0deg')
'#oklch(50%, 0%, 0deg)'
>>> oklch('50%', '0%', '0deg', '50%')
'#oklch(50%, 0%, 0deg, 50%)'

std.outline:

>>> outline()
'#outline()'
>>> outline(title='"Hello, World!"', target=heading.where(outlined=True))
'#outline(title: "Hello, World!", target: heading.where(outlined: true))'

std.overline:

>>> overline('"Hello, World!"')
'#overline("Hello, World!")'
>>> overline('[Hello, World!]')
'#overline([Hello, World!])'
>>> overline(
...     upper('"Hello, World!"'),
...     stroke='red',
...     offset='0pt',
...     extent='0pt',
...     evade=False,
...     background=True,
... )
'#overline(upper("Hello, World!"), stroke: red, offset: 0pt, evade: false, background: true)'

std.pad:

>>> pad(
...     lorem(20),
...     left='4% + 0pt',
...     top='4% + 0pt',
...     right='4% + 0pt',
...     bottom='4% + 0pt',
... )
'#pad(lorem(20), left: 4% + 0pt, top: 4% + 0pt, right: 4% + 0pt, bottom: 4% + 0pt)'

std.page:

>>> page(lorem(20))
'#page(lorem(20))'
>>> page(lorem(20), paper='"a0"', width='8.5in', height='11in')
'#page(lorem(20), paper: "a0", width: 8.5in, height: 11in)'

std.pagebreak:

>>> pagebreak()
'#pagebreak()'
>>> pagebreak(weak=True)
'#pagebreak(weak: true)'
>>> pagebreak(to='"even"')
'#pagebreak(to: "even")'

std.par:

>>> par('"Hello, World!"')
'#par("Hello, World!")'
>>> par('[Hello, World!]')
'#par([Hello, World!])'
>>> par(
...     '[Hello, World!]',
...     leading='0.1em',
...     spacing='0.5em',
...     justify=True,
...     linebreaks='"simple"',
...     first_line_indent='0.2em',
...     hanging_indent='0.3em',
... )
'#par([Hello, World!], leading: 0.1em, spacing: 0.5em, justify: true, linebreaks: "simple", first-line-indent: 0.2em, hanging-indent: 0.3em)'

std.parbreak:

>>> parbreak()
'#parbreak()'

std.place:

>>> place(lorem(20))
'#place(lorem(20))'
>>> place(lorem(20), 'top')
'#place(top, lorem(20))'

std.place.flush:

>>> place.flush()
'#place.flush()'

std.quote:

>>> quote('"Hello, World!"')
'#quote("Hello, World!")'
>>> quote('"Hello, World!"', block=True)
'#quote("Hello, World!", block: true)'
>>> quote('"Hello, World!"', quotes=False)
'#quote("Hello, World!", quotes: false)'
>>> quote('"Hello, World!"', attribution='"John Doe"')
'#quote("Hello, World!", attribution: "John Doe")'

std.raw:

>>> raw('"Hello, World!"')
'#raw("Hello, World!")'
>>> raw('"Hello, World!"', block=True, align='center')
'#raw("Hello, World!", block: true, align: center)'
>>> raw('"Hello, World!"', lang='"rust"')
'#raw("Hello, World!", lang: "rust")'
>>> raw('"Hello, World!"', tab_size=4)
'#raw("Hello, World!", tab-size: 4)'

std.raw.line:

>>> raw.line(1, 1, '"Hello, World!"', '"Hello, World!"')
'#raw.line(1, 1, "Hello, World!", "Hello, World!")'

std.ref:

>>> ref('<label>')
'#ref(<label>)'
>>> ref('<label>', supplement='[Hello, World!]')
'#ref(<label>, supplement: [Hello, World!])'

std.repeat:

>>> repeat(lorem(20), gap='0.5em')
'#repeat(lorem(20), gap: 0.5em)'
>>> repeat(lorem(20), gap='0.5em', justify=False)
'#repeat(lorem(20), gap: 0.5em, justify: false)'

std.rgb:

>>> rgb(255, 255, 255)
'#rgb(255, 255, 255)'
>>> rgb('50%', '50%', '50%', '50%')
'#rgb(50%, 50%, 50%, 50%)'
>>> rgb('"#ffffff"')
'#rgb("#ffffff")'

std.rotate:

>>> rotate(lorem(20), '20deg')
'#rotate(20deg, lorem(20))'
>>> rotate(lorem(20), '20deg', origin='left + horizon')
'#rotate(20deg, lorem(20), origin: left + horizon)'

std.scale:

>>> scale(lorem(20), '50%')
'#scale(50%, lorem(20))'
>>> scale(lorem(20), x='50%', y='50%')
'#scale(lorem(20), x: 50%, y: 50%)'
>>> scale(lorem(20), '50%', x='50%', y='50%')
'#scale(50%, lorem(20), x: 50%, y: 50%)'

std.skew:

>>> skew(lorem(20), ax='10deg', ay='20deg')
'#skew(lorem(20), ax: 10deg, ay: 20deg)'
>>> skew(
...     lorem(20), ax='10deg', ay='20deg', origin='left + horizon', reflow=True
... )
'#skew(lorem(20), ax: 10deg, ay: 20deg, origin: left + horizon, reflow: true)'

std.smallcaps:

>>> smallcaps('"Hello, World!"')
'#smallcaps("Hello, World!")'
>>> smallcaps('[Hello, World!]')
'#smallcaps([Hello, World!])'
>>> smallcaps('"Hello, World!"', all=True)
'#smallcaps("Hello, World!", all: true)'

std.smartquote:

>>> smartquote(double=False, enabled=False, alternative=True, quotes='"()"')
'#smartquote(double: false, enabled: false, alternative: true, quotes: "()")'
>>> smartquote(quotes=('"()"', '"dict()"'))
'#smartquote(quotes: ("()", "dict()"))'

std.stack:

>>> stack(rect(width='40pt'), dir='btt')
'#stack(dir: btt, rect(width: 40pt))'
>>> stack(
...     rect(width='40pt'), rect(width='120pt'), rect(width='90pt'), dir='btt'
... )
'#stack(dir: btt, rect(width: 40pt), rect(width: 120pt), rect(width: 90pt))'
>>> stack(
...     (rect(width='40pt'), rect(width='120pt'), rect(width='90pt')), dir='btt'
... )
'#stack(dir: btt, ..(rect(width: 40pt), rect(width: 120pt), rect(width: 90pt)))'

std.strike:

>>> strike('"Hello, World!"')
'#strike("Hello, World!")'
>>> strike('[Hello, World!]')
'#strike([Hello, World!])'
>>> strike(
...     upper('"Hello, World!"'),
...     stroke='red',
...     offset='0.1em',
...     extent='0.2em',
...     background=True,
... )
'#strike(upper("Hello, World!"), stroke: red, offset: 0.1em, extent: 0.2em, background: true)'

std.strong:

>>> strong('"Hello, World!"')
'#strong("Hello, World!")'
>>> strong('[Hello, World!]', delta=400)
'#strong([Hello, World!], delta: 400)'

std.subscript:

>>> subscript('"Hello, World!"')
'#sub("Hello, World!")'
>>> subscript('[Hello, World!]')
'#sub([Hello, World!])'
>>> subscript(
...     '[Hello, World!]', typographic=False, baseline='0.3em', size='0.7em'
... )
'#sub([Hello, World!], typographic: false, baseline: 0.3em, size: 0.7em)'

std.superscript:

>>> superscript('"Hello, World!"')
'#super("Hello, World!")'
>>> superscript('[Hello, World!]')
'#super([Hello, World!])'
>>> superscript(
...     '[Hello, World!]', typographic=False, baseline='-0.4em', size='0.7em'
... )
'#super([Hello, World!], typographic: false, baseline: -0.4em, size: 0.7em)'

std.table:

>>> table('[1]')
'#table([1])'
>>> table('[1]', '[2]', '[3]')
'#table([1], [2], [3])'
>>> table(
...     '[1]',
...     '[2]',
...     '[3]',
...     columns=['1fr', '2fr', '3fr'],
...     rows=['1fr', '2fr', '3fr'],
...     gutter=['1fr', '2fr', '3fr'],
...     column_gutter=['1fr', '2fr', '3fr'],
...     row_gutter=['1fr', '2fr', '3fr'],
...     fill='red',
...     align=['center', 'center', 'center'],
... )
'#table(columns: (1fr, 2fr, 3fr), rows: (1fr, 2fr, 3fr), gutter: (1fr, 2fr, 3fr), column-gutter: (1fr, 2fr, 3fr), row-gutter: (1fr, 2fr, 3fr), fill: red, align: (center, center, center), [1], [2], [3])'

std.terms:

>>> terms(('[1]', lorem(20)))
'#terms(([1], lorem(20)))'
>>> terms(('[1]', lorem(20)), ('[1]', lorem(20)))
'#terms(([1], lorem(20)), ([1], lorem(20)))'
>>> terms(('[1]', lorem(20)), ('[1]', lorem(20)), tight=False)
'#terms(tight: false, ([1], lorem(20)), ([1], lorem(20)))'
>>> terms(terms.item('[1]', lorem(20)), terms.item('[1]', lorem(20)))
'#terms(terms.item([1], lorem(20)), terms.item([1], lorem(20)))'

std.terms.item:

>>> terms.item('"term"', '"description"')
'#terms.item("term", "description")'

std.text:

>>> text('"Hello, World!"')
'#text("Hello, World!")'
>>> text('[Hello, World!]')
'#text([Hello, World!])'
>>> text('[Hello, World!]', font='"Times New Roman"')
'#text([Hello, World!], font: "Times New Roman")'

std.tiling:

>>> from typstpy.std.layout import place
>>> tiling(
...     f'[{place(line(start=("0%", "0%"), end=("100%", "100%")))}, {place(line(start=("0%", "100%"), end=("100%", "0%")))}]',
...     size=('30pt', '30pt'),
... )
'#tiling([#place(line(start: (0%, 0%), end: (100%, 100%))), #place(line(start: (0%, 100%), end: (100%, 0%)))], size: (30pt, 30pt))'

std.title:

>>> title()
'#title()'
>>> title('[My Thesis]')
'#title([My Thesis])'

std.underline:

>>> underline('"Hello, World!"')
'#underline("Hello, World!")'
>>> underline('[Hello, World!]')
'#underline([Hello, World!])'
>>> underline(
...     '[Hello, World!]',
...     stroke='1pt + red',
...     offset='0pt',
...     extent='1pt',
...     evade=False,
...     background=True,
... )
'#underline([Hello, World!], stroke: 1pt + red, offset: 0pt, extent: 1pt, evade: false, background: true)'

std.upper:

>>> upper('"Hello, World!"')
'#upper("Hello, World!")'
>>> upper('[Hello, World!]')
'#upper([Hello, World!])'
>>> upper(lower('"Hello, World!"'))
'#upper(lower("Hello, World!"))'

std.visualize.path:

>>> path(('0%', '0%'), ('100%', '0%'), ('100%', '100%'), ('0%', '100%'))
'#path((0%, 0%), (100%, 0%), (100%, 100%), (0%, 100%))'
>>> path(
...     ('0%', '0%'),
...     ('100%', '0%'),
...     ('100%', '100%'),
...     ('0%', '100%'),
...     fill='red',
... )
'#path(fill: red, (0%, 0%), (100%, 0%), (100%, 100%), (0%, 100%))'
>>> path(
...     ('0%', '0%'),
...     ('100%', '0%'),
...     ('100%', '100%'),
...     ('0%', '100%'),
...     fill='red',
...     stroke='blue',
... )
'#path(fill: red, stroke: blue, (0%, 0%), (100%, 0%), (100%, 100%), (0%, 100%))'

std.vspace:

>>> vspace('1em')
'#v(1em)'
>>> vspace('1em', weak=True)
'#v(1em, weak: true)'

subpar.grid:

>>> grid(
...     figure(image('"image.png"')),
...     '<a>',
...     figure(image('"image.png"')),
...     '<b>',
...     columns=('1fr', '1fr'),
...     caption='[A figure composed of two sub figures.]',
...     label='<full>',
... )
'#subpar.grid(figure(image("image.png")), <a>, figure(image("image.png")), <b>, columns: (1fr, 1fr), caption: [A figure composed of two sub figures.], label: <full>)'

Project details

Release history Release notifications | RSS feed

1.4.0

Jun 2, 2026

1.4.0a1 pre-release

May 24, 2026

This version

1.4.0a0 pre-release

May 24, 2026

1.3.1a0 pre-release

May 24, 2026

1.3.0

Jan 4, 2026

1.2.1

Sep 17, 2025

1.2.0

May 11, 2025

1.1.1

Jan 16, 2025

1.1.0

Jan 14, 2025

1.0.4

Jan 12, 2025

1.0.3

Jan 10, 2025

1.0.2

Jan 8, 2025

1.0.1

Dec 27, 2024

1.0.0

Dec 25, 2024

1.0.0b2 pre-release

Dec 23, 2024

1.0.0b1 pre-release

Dec 22, 2024

0.1.2

Dec 16, 2024

0.1.1

Dec 7, 2024

0.1.0

Oct 18, 2024

0.0.6

Oct 2, 2024

0.0.5

Sep 27, 2024

0.0.4

Sep 26, 2024

0.0.3

Sep 24, 2024

0.0.2

Sep 24, 2024

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typstpy-1.4.0a0.tar.gz (64.4 kB view details)

Uploaded May 24, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

typstpy-1.4.0a0-py3-none-any.whl (52.7 kB view details)

Uploaded May 24, 2026 Python 3

File details

Details for the file typstpy-1.4.0a0.tar.gz.

File metadata

Download URL: typstpy-1.4.0a0.tar.gz
Upload date: May 24, 2026
Size: 64.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for typstpy-1.4.0a0.tar.gz
Algorithm	Hash digest
SHA256	`1f6e170dde0c1f9c048dccb8059d3a4ff9ae3982213ff8fcfc658a4cfc7a60d0`
MD5	`5aa9a2b4b922273181e1562648003d4a`
BLAKE2b-256	`95063007e8ed88ca5699379614b737fd3bf261e2e35fa752f233a920f3042bf0`

See more details on using hashes here.

File details

Details for the file typstpy-1.4.0a0-py3-none-any.whl.

File metadata

Download URL: typstpy-1.4.0a0-py3-none-any.whl
Upload date: May 24, 2026
Size: 52.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for typstpy-1.4.0a0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`781de81886668672654f6d7395a1f133d761c5d4299fa27d15605615cc6786af`
MD5	`ca2e8868a6b630a8b7b70415959e4e7b`
BLAKE2b-256	`22f019403980eb252eb4e6556502968a3df8386e10600e8aba1ba536871146cc`

See more details on using hashes here.

typstpy 1.4.0a0

Navigation

Verified details

Maintainers

Meta

Unverified details

Meta

Project description

typstpy

Introduction

Change logs

Installation

How to customize?

Current Supports

Examples

Project details

Verified details

Maintainers

Meta

Unverified details

Meta

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes