helpers icon indicating copy to clipboard operation
helpers copied to clipboard

Improve instructions to dockerized executable

Open gpsaggese opened this issue 9 months ago • 4 comments

  • [x] Update this ./dev_scripts_helpers/dockerize/dockerized_template.py to 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

gpsaggese avatar Mar 15 '25 21:03 gpsaggese

Re documentation: we already have this doc on dockerized executables. It can be updated if needed.

sonniki avatar Mar 17 '25 07:03 sonniki

Good pointer. Let's always keep improving things instead of starting from scratch.

gpsaggese avatar Mar 17 '25 20:03 gpsaggese

@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_*.

Shaunak01 avatar Mar 27 '25 02:03 Shaunak01

  • 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?

gpsaggese avatar Mar 27 '25 18:03 gpsaggese

PR: https://github.com/causify-ai/helpers/pull/434

Shaunak01 avatar Mar 31 '25 15:03 Shaunak01

closing as merged : https://github.com/causify-ai/helpers/pull/434

Shaunak01 avatar Apr 02 '25 12:04 Shaunak01