cooklang-py
A parser for the Cooklang recipe markup language
Installation
To install just run:
pip install cooklang-py
Documentation
Full documentation is available at https://cooklang-py.readthedocs.io/
Recipe
The Recipe is the primary unit. There are 2 ways to create a Recipe object:
from cooklang_py import Recipe
# Create from a string in memory
recipe_string = '<your recipe here>'
recipe = Recipe(recipe_string)
# Create from a file
recipe_file = '/path/to/recipe/file'
recipe = Recipe.from_file(recipe_file)
Just like a recipe in a book a Recipe contains:
- Ingredients
- Cookware / equipment
- Timings
- Metadata (servings, cook time, etc.)
To see how to define these in your input please refer to the Cooklang language specification
When the recipe is parsed there will be a list of Step objects. Each step object can contain:
- Ingredients
- Cookware
- Timings
- Instructions (text)
At both the Recipe and Step level you can access the list of Ingredients and Cookware
for the recipe or step.
Cookware, Timings, and Ingredients
Cookware, timings, and ingredients are the backbone of the recipe. In this package all three
inherit from the BaseObj. They all have the following 3 attributes:
name- the name of the item (i.e. pot, carrot, etc.)quantity- how much is needednotes- any notes for the item (i.e. "greased", "peeled and diced", etc.)Timingsdo not have notes per the Cooklang specification.
Overriding implementations
The implementations of Cookware, Timings, and Ingredients can be overridden by creating a new
implementation (inheriting from either that class or from BaseObj) and calling Recipe or
Step with an updated prefixes dictionary that points the desired prefix to the new class.
Compatibility
cooklang-py passes all canonical tests defined at
https://github.com/cooklang/cooklang-rs/blob/main/tests/canonical.yaml
for the following platforms:
- Linux
- MacOS
- Windows
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cooklang_py-1.0.1.tar.gz.
File metadata
- Download URL: cooklang_py-1.0.1.tar.gz
- Upload date:
- Size: 8.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c96228ccde1423de39e3737cf5695d016e89c5902fa15ec1e3c6aceacd554518
|
|
| MD5 |
10728942500c8e93b858ef79634a932b
|
|
| BLAKE2b-256 |
df1392d20c4897b32d7a2d9ca021f15bb0dafed186cc96e604e690bd2fb4fa8d
|
Provenance
The following attestation bundles were made for cooklang_py-1.0.1.tar.gz:
Publisher:
publish.yml on brass75/cooklang-py
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cooklang_py-1.0.1.tar.gz -
Subject digest:
c96228ccde1423de39e3737cf5695d016e89c5902fa15ec1e3c6aceacd554518 - Sigstore transparency entry: 1983572908
- Sigstore integration time:
-
Permalink:
brass75/cooklang-py@a9e7090e7fb07104b5d5289d67254ea26eaf1a2d -
Branch / Tag:
refs/tags/1.0.1 - Owner: https://github.com/brass75
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@a9e7090e7fb07104b5d5289d67254ea26eaf1a2d -
Trigger Event:
release
-
Statement type:
File details
Details for the file cooklang_py-1.0.1-py3-none-any.whl.
File metadata
- Download URL: cooklang_py-1.0.1-py3-none-any.whl
- Upload date:
- Size: 10.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec033092c167651328200e8a5420a3cbf35848a0211678e95bfcc9832921c111
|
|
| MD5 |
8b7d27b2ab0f3eae39346382ad33dee2
|
|
| BLAKE2b-256 |
8b196723f5f50da9c82b1dc6e8fe7758c73857f66d2fe419086f468bcbf93f52
|
Provenance
The following attestation bundles were made for cooklang_py-1.0.1-py3-none-any.whl:
Publisher:
publish.yml on brass75/cooklang-py
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cooklang_py-1.0.1-py3-none-any.whl -
Subject digest:
ec033092c167651328200e8a5420a3cbf35848a0211678e95bfcc9832921c111 - Sigstore transparency entry: 1983572995
- Sigstore integration time:
-
Permalink:
brass75/cooklang-py@a9e7090e7fb07104b5d5289d67254ea26eaf1a2d -
Branch / Tag:
refs/tags/1.0.1 - Owner: https://github.com/brass75
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@a9e7090e7fb07104b5d5289d67254ea26eaf1a2d -
Trigger Event:
release
-
Statement type:
