Skip to main content

struckdown

Markdown-based syntax for structured conversations with language models.

Installation

pip install struckdown

Quick Example

# Configure
export LLM_API_KEY="sk-..."
export LLM_API_BASE="https://api.openai.com/v1"

# Extract structured data
sd chat "Tell me a joke: [[joke]]"
sd batch -i '*.txt' "Purpose: [[purpose]] Price: [[number:price]]"

Images

Wrap an image with attach() and it goes where its variable is rendered:

from struckdown import complete, attach

complete("Read this sheet: {{ sheet }} [[extract:answers]]", {"sheet": attach("scan.jpg")})

Images are resized, turned upright and stripped of metadata before sending. From the command line, use sd chat --attach name=path or sd batch --as-image. Install with pip install 'struckdown[vision]'; see Images.

Documentation

Full documentation, examples, and tutorials:

https://github.com/benwhalley/struckdown

License

MIT

Metadata

Release files for struckdown 0.17.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for struckdown 0.17.1
File Size Uploaded Provenance Actions
struckdown-0.17.1.tar.gz 1.5 MB Without provenance Details for struckdown-0.17.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for struckdown 0.17.1
File Interpreter ABI Platform Actions
struckdown-0.17.1-py3-none-any.whl Python 3 none any Details for struckdown-0.17.1-py3-none-any.whl

Total release size: 2.8 MB

Release files / struckdown-0.17.1.tar.gz

Download URL struckdown-0.17.1.tar.gz
Size 1.5 MB
Tags Source
SHA-256 checksum
How to use checksums
929c81626d4d703254523560a9ca3f6440e24489a7bdbf826b00954ae38ec5d3
BLAKE2b-256 checksum
How to use checksums
fc8e5f9be541c17faa056873f07471bda8539214be175e3a39243d8999071392
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / struckdown-0.17.1-py3-none-any.whl

Download URL struckdown-0.17.1-py3-none-any.whl
Size 1.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
502e36bcc4a6a98fa5806d5e97feabfb480636eeac6b1e6acf57272fb1f5275e
BLAKE2b-256 checksum
How to use checksums
5ebfcecc6d4dc4d545438b23a09e67b34bc944267bd39505a33a5431d6a26d27
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Security for struckdown 0.17.1

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.

Release history Release notifications | RSS feed

This release

0.17.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page