Python interface to generate executable Typst code.

These details have not been verified by PyPI

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.2.0: Support for typst version: 0.13.x.
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
std.visualize.circle	circle	https://typst.app/docs/reference/visualize/circle/
std.visualize._color_map	color.map	https://typst.app/docs/reference/visualize/color/#predefined-color-maps
std.visualize.luma	luma	https://typst.app/docs/reference/visualize/color/#definitions-luma
std.visualize.oklab	oklab	https://typst.app/docs/reference/visualize/color/#definitions-oklab
std.visualize.oklch	oklch	https://typst.app/docs/reference/visualize/color/#definitions-oklch
std.visualize._color_linear_rgb	color.linear-rgb	https://typst.app/docs/reference/visualize/color/#definitions-linear-rgb
std.visualize.rgb	rgb	https://typst.app/docs/reference/visualize/color/#definitions-rgb
std.visualize.cmyk	cmyk	https://typst.app/docs/reference/visualize/color/#definitions-cmyk
std.visualize._color_hsl	color.hsl	https://typst.app/docs/reference/visualize/color/#definitions-hsl
std.visualize._color_hsv	color.hsv	https://typst.app/docs/reference/visualize/color/#definitions-hsv
std.visualize._color_components	components	https://typst.app/docs/reference/visualize/color/#definitions-components
std.visualize._color_space	space	https://typst.app/docs/reference/visualize/color/#definitions-space
std.visualize._color_to_hex	to-hex	https://typst.app/docs/reference/visualize/color/#definitions-to-hex
std.visualize._color_lighten	lighten	https://typst.app/docs/reference/visualize/color/#definitions-lighten
std.visualize._color_darken	darken	https://typst.app/docs/reference/visualize/color/#definitions-darken
std.visualize._color_saturate	saturate	https://typst.app/docs/reference/visualize/color/#definitions-saturate
std.visualize._color_desaturate	desaturate	https://typst.app/docs/reference/visualize/color/#definitions-desaturate
std.visualize._color_negate	negate	https://typst.app/docs/reference/visualize/color/#definitions-negate
std.visualize._color_rotate	rotate	https://typst.app/docs/reference/visualize/color/#definitions-rotate
std.visualize._color_mix	color.mix	https://typst.app/docs/reference/visualize/color/#definitions-mix
std.visualize._color_transparentize	transparentize	https://typst.app/docs/reference/visualize/color/#definitions-transparentize
std.visualize._color_opacify	opacify	https://typst.app/docs/reference/visualize/color/#definitions-opacify
std.visualize.color	color	https://typst.app/docs/reference/visualize/color/
std.visualize._curve_move	curve.move	https://typst.app/docs/reference/visualize/curve/#definitions-move
std.visualize._curve_line	curve.line	https://typst.app/docs/reference/visualize/curve/#definitions-line
std.visualize._curve_quad	curve.quad	https://typst.app/docs/reference/visualize/curve/#definitions-quad
std.visualize._curve_cubic	curve.cubic	https://typst.app/docs/reference/visualize/curve/#definitions-cubic
std.visualize._curve_close	curve.close	https://typst.app/docs/reference/visualize/curve/#definitions-close
std.visualize.curve	curve	https://typst.app/docs/reference/visualize/curve/
std.visualize.ellipse	ellipse	https://typst.app/docs/reference/visualize/ellipse/
std.visualize._gradient_linear	gradient.linear	https://typst.app/docs/reference/visualize/gradient/#definitions-linear
std.visualize._gradient_radial	gradient.radial	https://typst.app/docs/reference/visualize/gradient/#definitions-radial
std.visualize._gradient_conic	gradient.conic	https://typst.app/docs/reference/visualize/gradient/#definitions-conic
std.visualize._gradient_sharp	sharp	https://typst.app/docs/reference/visualize/gradient/#definitions-sharp
std.visualize._gradient_repeat	repeat	https://typst.app/docs/reference/visualize/gradient/#definitions-repeat
std.visualize._gradient_kind	kind	https://typst.app/docs/reference/visualize/gradient/#definitions-kind
std.visualize._gradient_stops	stops	https://typst.app/docs/reference/visualize/gradient/#definitions-stops
std.visualize._gradient_space	space	https://typst.app/docs/reference/visualize/gradient/#definitions-space
std.visualize._gradient_relative	relative	https://typst.app/docs/reference/visualize/gradient/#definitions-relative
std.visualize._gradient_angle	angle	https://typst.app/docs/reference/visualize/gradient/#definitions-angle
std.visualize._gradient_center	center	https://typst.app/docs/reference/visualize/gradient/#definitions-center
std.visualize._gradient_radius	radius	https://typst.app/docs/reference/visualize/gradient/#definitions-radius
std.visualize._gradient_focal_center	focal-center	https://typst.app/docs/reference/visualize/gradient/#definitions-focal-center
std.visualize._gradient_focal_radius	focal-radius	https://typst.app/docs/reference/visualize/gradient/#definitions-focal-radius
std.visualize._gradient_sample	sample	https://typst.app/docs/reference/visualize/gradient/#definitions-sample
std.visualize._gradient_samples	samples	https://typst.app/docs/reference/visualize/gradient/#definitions-samples
std.visualize.gradient	gradient	https://typst.app/docs/reference/visualize/gradient/
std.visualize._image_decode	image.decode	https://typst.app/docs/reference/visualize/image/#definitions-decode
std.visualize.image	image	https://typst.app/docs/reference/visualize/image/
std.visualize.line	line	https://typst.app/docs/reference/visualize/line/
std.visualize.path	path	https://typst.app/docs/reference/visualize/path/
std.visualize.pattern	pattern	https://typst.app/docs/reference/visualize/pattern/
std.visualize._polygon_regular	polygon.regular	https://typst.app/docs/reference/visualize/polygon/#definitions-regular
std.visualize.polygon	polygon	https://typst.app/docs/reference/visualize/polygon/
std.visualize.rect	rect	https://typst.app/docs/reference/visualize/rect/
std.visualize.square	square	https://typst.app/docs/reference/visualize/square/
std.text.highlight	highlight	https://typst.app/docs/reference/text/highlight/
std.text.linebreak	linebreak	https://typst.app/docs/reference/text/linebreak/
std.text.lorem	lorem	https://typst.app/docs/reference/text/lorem/
std.text.lower	lower	https://typst.app/docs/reference/text/lower/
std.text.overline	overline	https://typst.app/docs/reference/text/overline/
std.text._raw_line	raw.line	https://typst.app/docs/reference/text/raw/#definitions-line
std.text.raw	raw	https://typst.app/docs/reference/text/raw/
std.text.smallcaps	smallcaps	https://typst.app/docs/reference/text/smallcaps/
std.text.smartquote	smartquote	https://typst.app/docs/reference/text/smartquote/
std.text.strike	strike	https://typst.app/docs/reference/text/strike/
std.text.subscript	sub	https://typst.app/docs/reference/text/sub/
std.text.superscript	super	https://typst.app/docs/reference/text/super/
std.text.text	text	https://typst.app/docs/reference/text/text/
std.text.underline	underline	https://typst.app/docs/reference/text/underline/
std.text.upper	upper	https://typst.app/docs/reference/text/upper/
std.layout.align	align	https://typst.app/docs/reference/layout/align/
std.layout.block	block	https://typst.app/docs/reference/layout/block/
std.layout.box	box	https://typst.app/docs/reference/layout/box/
std.layout.colbreak	colbreak	https://typst.app/docs/reference/layout/colbreak/
std.layout.columns	columns	https://typst.app/docs/reference/layout/columns/
std.layout._grid_cell	grid.cell	https://typst.app/docs/reference/layout/grid/#definitions-cell
std.layout._grid_hline	grid.hline	https://typst.app/docs/reference/layout/grid/#definitions-hline
std.layout._grid_vline	grid.vline	https://typst.app/docs/reference/layout/grid/#definitions-vline
std.layout._grid_header	grid.header	https://typst.app/docs/reference/layout/grid/#definitions-header
std.layout._grid_footer	grid.footer	https://typst.app/docs/reference/layout/grid/#definitions-footer
std.layout.grid	grid	https://typst.app/docs/reference/layout/grid/
std.layout.hide	hide	https://typst.app/docs/reference/layout/hide/
std.layout.layout	layout	https://typst.app/docs/reference/layout/layout/
std.layout.measure	measure	https://typst.app/docs/reference/layout/measure/
std.layout.move	move	https://typst.app/docs/reference/layout/move/
std.layout.pad	pad	https://typst.app/docs/reference/layout/pad/
std.layout.page	page	https://typst.app/docs/reference/layout/page/
std.layout.pagebreak	pagebreak	https://typst.app/docs/reference/layout/pagebreak/
std.layout._place_flush	place.flush	https://typst.app/docs/reference/layout/place/#definitions-flush
std.layout.place	place	https://typst.app/docs/reference/layout/place/
std.layout.repeat	repeat	https://typst.app/docs/reference/layout/repeat/
std.layout.rotate	rotate	https://typst.app/docs/reference/layout/rotate/
std.layout.scale	scale	https://typst.app/docs/reference/layout/scale/
std.layout.skew	skew	https://typst.app/docs/reference/layout/skew/
std.layout.hspace	h	https://typst.app/docs/reference/layout/h/
std.layout.vspace	v	https://typst.app/docs/reference/layout/v/
std.layout.stack	stack	https://typst.app/docs/reference/layout/stack/
std.model.bibliography	bibliography	https://typst.app/docs/reference/model/bibliography/
std.model._bullet_list_item	list.item	https://typst.app/docs/reference/model/list/#definitions-item
std.model.bullet_list	list	https://typst.app/docs/reference/model/list/
std.model.cite	cite	https://typst.app/docs/reference/model/cite/
std.model.document	document	https://typst.app/docs/reference/model/document/
std.model.emph	emph	https://typst.app/docs/reference/model/emph/
std.model._figure_caption	figure.caption	https://typst.app/docs/reference/model/figure/#definitions-caption
std.model.figure	figure	https://typst.app/docs/reference/model/figure/
std.model._footnote_entry	footnote.entry	https://typst.app/docs/reference/model/footnote/#definitions-entry
std.model.footnote	footnote	https://typst.app/docs/reference/model/footnote/
std.model.heading	heading	https://typst.app/docs/reference/model/heading/
std.model.link	link	https://typst.app/docs/reference/model/link/
std.model._numbered_list_item	enum.item	https://typst.app/docs/reference/model/enum/#definitions-item
std.model.numbered_list	enum	https://typst.app/docs/reference/model/enum/
std.model.numbering	numbering	https://typst.app/docs/reference/model/numbering/
std.model._outline_entry	outline.entry	https://typst.app/docs/reference/model/outline/#definitions-entry
std.model._outline_indented	indented	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-indented
std.model._outline_prefix	prefix	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-prefix
std.model._outline_inner	inner	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-inner
std.model._outline_body	body	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-body
std.model._outline_page	page	https://typst.app/docs/reference/model/outline/#definitions-entry-definitions-page
std.model.outline	outline	https://typst.app/docs/reference/model/outline/
std.model._par_line	par.line	https://typst.app/docs/reference/model/par/#definitions-line
std.model.par	par	https://typst.app/docs/reference/model/par/
std.model.parbreak	parbreak	https://typst.app/docs/reference/model/parbreak/
std.model.quote	quote	https://typst.app/docs/reference/model/quote/
std.model.ref	ref	https://typst.app/docs/reference/model/ref/
std.model.strong	strong	https://typst.app/docs/reference/model/strong/
std.model._table_cell	table.cell	https://typst.app/docs/reference/model/table/#definitions-cell
std.model._table_hline	table.hline	https://typst.app/docs/reference/model/table/#definitions-hline
std.model._table_vline	table.vline	https://typst.app/docs/reference/model/table/#definitions-vline
std.model._table_header	table.header	https://typst.app/docs/reference/model/table/#definitions-header
std.model._table_footer	table.footer	https://typst.app/docs/reference/model/table/#definitions-footer
std.model.table	table	https://typst.app/docs/reference/model/table/
std.model._terms_item	terms.item	https://typst.app/docs/reference/model/terms/#definitions-item
std.model.terms	terms	https://typst.app/docs/reference/model/terms/
subpar.grid	subpar.grid	https://typst.app/universe/package/subpar

Examples

std.visualize.circle:

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

std.visualize._color_map:

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

std.visualize.luma:

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

std.visualize.oklab:

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

std.visualize.oklch:

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

std.visualize._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.visualize.rgb:

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

std.visualize.cmyk:

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

std.visualize._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.visualize._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.visualize._color_components:

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

std.visualize._color_space:

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

std.visualize._color_to_hex:

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

std.visualize._color_lighten:

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

std.visualize._color_darken:

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

std.visualize._color_saturate:

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

std.visualize._color_desaturate:

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

std.visualize._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.visualize._color_rotate:

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

std.visualize._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.visualize._color_transparentize:

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

std.visualize._color_opacify:

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

std.visualize.color:

>>> color()
'#color'

std.visualize._curve_move:

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

std.visualize._curve_line:

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

std.visualize._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.visualize._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.visualize._curve_close:

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

std.visualize.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.visualize.ellipse:

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

std.visualize._gradient_linear:

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

std.visualize._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.visualize._gradient_conic:

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

std.visualize._gradient_sharp:

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

std.visualize.gradient:

>>> gradient()
'#gradient'

std.visualize.image:

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

std.visualize.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.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.text.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.text.linebreak:

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

std.text.lorem:

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

std.text.lower:

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

std.text.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.text._raw_line:

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

std.text.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.text.smallcaps:

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

std.text.smartquote:

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

std.text.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.text.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.text.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.text.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.text.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.text.upper:

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

std.layout.align:

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

std.layout.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.layout.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.layout.colbreak:

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

std.layout.columns:

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

std.layout._grid_cell:

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

std.layout.grid:

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

std.layout.hide:

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

std.layout.move:

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

std.layout.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.layout.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.layout.pagebreak:

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

std.layout._place_flush:

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

std.layout.place:

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

std.layout.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.layout.rotate:

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

std.layout.scale:

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

std.layout.skew:

>>> skew(lorem(20), ax='10deg', ay='20deg')
'#skew(lorem(20), ax: 10deg, ay: 20deg)'

std.layout.hspace:

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

std.layout.vspace:

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

std.layout.stack:

>>> 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.model.bibliography:

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

std.model.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.model.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.model.emph:

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

std.model._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.model.figure:

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

std.model.footnote:

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

std.model.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.model.link:

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

std.model._numbered_list_item:

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

std.model.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.model.numbering:

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

std.model.outline:

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

std.model.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.model.parbreak:

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

std.model.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.model.ref:

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

std.model.strong:

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

std.model.table:

>>> 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.model._terms_item:

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

std.model.terms:

>>> 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)))'

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

These details have not been verified by PyPI

Release history Release notifications | RSS feed

1.3.0

Jan 4, 2026

1.2.1

Sep 17, 2025

This version

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.2.0.tar.gz (48.9 kB view details)

Uploaded May 11, 2025 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.2.0-py3-none-any.whl (46.3 kB view details)

Uploaded May 11, 2025 Python 3

File details

Details for the file typstpy-1.2.0.tar.gz.

File metadata

Download URL: typstpy-1.2.0.tar.gz
Upload date: May 11, 2025
Size: 48.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/2.1.2 CPython/3.12.5 Windows/11

File hashes

Hashes for typstpy-1.2.0.tar.gz
Algorithm	Hash digest
SHA256	`3aa87f0a45a4d5afc3168c51f56fca2eaec2bab3144ec126d1b476c9df73d9b1`
MD5	`a3248b1d50c539011311a932339c2942`
BLAKE2b-256	`a011687deab834efed97afb6419469da29c6b86f36e14f859028c02f126d058e`

See more details on using hashes here.

File details

Details for the file typstpy-1.2.0-py3-none-any.whl.

File metadata

Download URL: typstpy-1.2.0-py3-none-any.whl
Upload date: May 11, 2025
Size: 46.3 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/2.1.2 CPython/3.12.5 Windows/11

File hashes

Hashes for typstpy-1.2.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`5fdfb0eaefb105b645c81f09234289297a03d370b8b754a37a40a8b977141f78`
MD5	`bff6745d8c1238cba1d0f7f8f8934e3d`
BLAKE2b-256	`19bdb14a3ffd640779ddf2a9f3bd22d155721669ad971eeeadeffa1bb81007f2`

See more details on using hashes here.

typstpy 1.2.0

Navigation

Verified details

Maintainers

Meta

Unverified details

Meta

Classifiers

Project description

typstpy

Introduction

Change logs

Installation

How to customize?

Current Supports

Examples

Project details

Verified details

Maintainers

Meta

Unverified details

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

File details

File metadata

File hashes