hiro/py-vterm-interaction.el
1
0
Fork 0
mirror of https://github.com/vale981/py-vterm-interaction.el synced 2025-03-04 09:31:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

add info about REPL scripts

Browse source
This commit is contained in:
Valentin Boettcher 2024-05-16 11:30:58 -04:00
parent 067e67ea7e
commit d3a6d0235e
No known key found for this signature in database
GPG key ID: E034E12B7AF56ACE
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
scripts/README.org Normal file
View file

@ -0,0 +1,11 @@
* REPL Scripts
These are scripts intended to be run in the REPL by =python-vterm=. Each
script (except =utility.py=) should contain only one function of the
same name as the script file. All functions should not alter the
global state and have no observable side effects in the REPL. They can
only use standard python functionality.
Each function must take a file path as its first argument and write
its output as json to that path. All functions in =utility.py= are
available to call in each script without importing them. Among the is
~dump_json([path], [value])~.