diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..68bc17f --- /dev/null +++ b/.gitignore @@ -0,0 +1,160 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/README.md b/README.md index c7e47cc..7e0ec36 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ The LaTeX files use the [cuisine](https://ctan.org/pkg/cuisine) package. ## cook2tex.py Takes a recipe path as an argument and returns the cuisine recipe block on stdout. +Optionally, if provided with the argument "--", reads the recipes source from stdin. ### Example diff --git a/cook2tex.py b/cook2tex.py index 1ff8636..1362dbb 100644 --- a/cook2tex.py +++ b/cook2tex.py @@ -1,21 +1,16 @@ import sys, cooklang from os.path import exists -def parse_recipe(path): +def parse_recipe(cooklang_source): """ - Takes: string path + Takes: string cooklang_source Returns: [ string ] tex - Takes a recipe path as an argument and returns the cuisine recipe block. + Takes the recipes source as an argument and returns the cuisine recipe block. One element per line. """ - if not exists(path): - raise ArgumentError - - with open(path) as file: - # First argument is recipe file - recipe = cooklang.parseRecipe(file.read()) + recipe = cooklang.parseRecipe(cooklang_source) title = get_metadata_value("title", recipe) servings = get_metadata_value("servings", recipe) @@ -50,10 +45,20 @@ def parse_recipe(path): return tex -class ArgumentError(Exception): - def __init__(self): - self.message = "Please supply the path to a cooklang file as an argument." - super().__init__(self.message) +def parse_recipe_from_file(path): + """ + Takes: string path + Returns: [ string ] tex + + Takes a recipe path as an argument and returns the cuisine recipe block. + One element per line. + """ + if not exists(path): + raise ArgumentError + + with open(path) as file: + return parse_recipe(file.read()) + def get_metadata_value(key, recipe): if key in recipe["metadata"].keys(): @@ -97,6 +102,18 @@ def texify_ingredients(ingredients): return tex +class ArgumentError(Exception): + def __init__(self): + self.message = "Please supply the path to a cooklang file as an argument." + super().__init__(self.message) + + if __name__ == "__main__": - for line in parse_recipe(sys.argv[1]): - print(line) + + if sys.argv[1] == "--": + tex = parse_recipe(sys.stdin.read()) + else: + tex = parse_recipe_from_file(sys.argv[1]) + + for line in tex: + print(line) diff --git a/cooklangbook.py b/cooklangbook.py index 73f218d..a32d24c 100644 --- a/cooklangbook.py +++ b/cooklangbook.py @@ -17,7 +17,7 @@ def create_book(argv): for path in argv: tex.append("\n") - tex += cook2tex.parse_recipe(path) + tex += cook2tex.parse_recipe_from_file(path) tex.append("\n") tex.append("\\end{document}")