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.19.0

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.19.0
File Size Uploaded Provenance Actions
struckdown-0.19.0.tar.gz 1.4 MB Without provenance Details for struckdown-0.19.0.tar.gz

Built distribution (wheel)

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

Total release size: 2.8 MB

Release files / struckdown-0.19.0.tar.gz

Download URL struckdown-0.19.0.tar.gz
Size 1.4 MB
Tags Source
SHA-256 checksum
How to use checksums
b70a1b2fa01769524e79199ef84491acbcee3310ad6cf2fd7806e2728763dbf0
BLAKE2b-256 checksum
How to use checksums
4e8f4bcc30b56e3bc4abcb431d57cd6eefdb15529be12937a954d5c45b7f98b2
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.19.0-py3-none-any.whl

Download URL struckdown-0.19.0-py3-none-any.whl
Size 1.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
c6934505773e35d07ae1d07d1307560c4e11b8f5a4df384c18a50c7e10db86cf
BLAKE2b-256 checksum
How to use checksums
f215510a67967f2df0d05b8527c2ff9ab12af5d658c80ed5f06e7d555ceb04e9
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.19.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.19.0 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