Skip to main content

Bwyd culinary DSL

A domain specific language (DSL) to assist in taking notes about culinary work which is intended to be repeated.

This includes support for running in a Jupyter notebook, plus using graph technologies for analytics and preparation planning.


build a local environment

This project uses poetry for dependency management, virtual environment, builds, packaging, etc. To set up an environment locally:

git clone https://github.com/DerwenAI/bwyd.git
cd bwyd

poetry install --extras=demo

The source code is currently based on Python 3.11 or later.

run the demo script to generate HTML

poetry run python3 cli.py

Then load the examples/index.html in a browser.

eval a specific Bwyd file

poetry run python3 eval_rig.py <slug>

prep for Jupyter notebooks

poetry run python3 -m pip install -e .
poetry run python3 -m bwyd.install
poetry run jupyter-lab

development

To set up the test environment:

poetry install --extras=test

To run unit tests, type checking, and linting:

./lint.sh

To validate the generated HTML: https://validator.w3.org/nu/#file

files

  • bwyd/__main__.py: Jypter kernel CLI

  • bwyd/install.py: Jupyter kernel installer

  • bwyd/kernel.py: Jupyter wrapper kernel

  • config.toml: sample configuration settings

  • examples/*.bwyd: example recipes as Bwyd scripts

  • examples/*.ipynb: example recipes in Bwyd as Jupyter notebooks

  • examples/*.json: example recipes data model in JSON files

###################################################################### TBD:

uninstall

./venv/bin/jupyter kernelspec uninstall bwyd
python3 -m pip uninstall bwyd

Metadata

Release files for bwyd 0.4.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 bwyd 0.4.0
File Size Uploaded Provenance Actions
bwyd-0.4.0.tar.gz 27.7 kB Without provenance Details for bwyd-0.4.0.tar.gz

Built distribution (wheel)

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

Total release size: 60.5 kB

Release files / bwyd-0.4.0.tar.gz

Download URL bwyd-0.4.0.tar.gz
Size 27.7 kB
Tags Source
SHA-256 checksum
How to use checksums
0b7011dbbe63aef3c4626bea4af9bc8243af9caca1bc3c867ab5dc1fbd9dcc96
BLAKE2b-256 checksum
How to use checksums
ccff43757b1e85bc2f18e3500131882ad60d79dc9c7098057d59179fb59c1317
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.13.8 Darwin/25.5.0

Release files / bwyd-0.4.0-py3-none-any.whl

Download URL bwyd-0.4.0-py3-none-any.whl
Size 32.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
444db178dbb0e1edfbac4c7ce19e3a2370271b44c95fb38d087ed013183ff114
BLAKE2b-256 checksum
How to use checksums
a0b9a3cdefc445ff35ad35c3b6a8b1aafedb8f1ecd6b8907643b9426cdd08736
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.13.8 Darwin/25.5.0

Security for bwyd 0.4.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.

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