Improve instructions to dockerized executable
- [x] Update this
./dev_scripts_helpers/dockerize/dockerized_template.pyto the new style (see ./dev_scripts_helpers/documentation/dockerized_*.py) - [x] Make a proposal of how it should look like. E.g., the dockerfile should be inside the caller script unless we want to have an interface in the code, like for Latex, prettier, & co.
- [x] Explain how to test it (e.g., using the executable, pointing to examples)
- [x] Add documentation about all of this somewhere so that we can point people on how to create dockerized executables
FYI @heanhsok @sonniki
Re documentation: we already have this doc on dockerized executables. It can be updated if needed.
Good pointer. Let's always keep improving things instead of starting from scratch.
@gpsaggese
Whats the reason we have named some files as
- dockerized_latex.py
- dockerized_mermaid.py
- dockerized_pandoc.py
and some other dockerized files with same purpose
- extract_notebook_images.py
- convert_docx_to_markdown.py
So some files dont start with dockerized_*.
-
My mental model is that the
dockerized_*are just wrappers around the corresponding tools, while the others are just scripts that perform some function and happen to use docker to achieve it.- I'm not sure if I follow this invariant consistently, so feel free to double check critically
-
[x] Can you add a note in the documentation about this rule?
PR: https://github.com/causify-ai/helpers/pull/434
closing as merged : https://github.com/causify-ai/helpers/pull/434