oh-my-batch 0.2.0__tar.gz → 0.2.1__tar.gz

{oh_my_batch-0.2.0 → oh_my_batch-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oh-my-batch
-Version: 0.2.0
+Version: 0.2.1
 Summary: 
 License: GPL
 Author: weihong.xu
@@ -22,19 +22,33 @@ Description-Content-Type: text/markdown
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/oh-my-batch)](https://pypi.org/project/oh-my-batch/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oh-my-batch)](https://pypi.org/project/oh-my-batch/)
 
-A simple tool to manipulate batch tasks designed for scientific computing community.
+A toolkit to manipulate batch tasks with command line. Designed for scientific computing community.
 
 ## Features
 * `omb combo`: generate folders/files from different combinations of parameters
 * `omb batch`: generate batch scripts from multiple working directories
 * `omb job`: track the state of job in job schedular
 
+## Shell Tips
+`oh-my-batch` is intended to help you implement computational workflows with shell scripts.
+To make the best use of `oh-my-batch`, you need to know some shell tips.
+
+* [Retry commands until success in shell script](https://stackoverflow.com/a/79191004/3099733)
+
 ## Install
 ```bash
 pip install oh-my-batch
 ```
 
 ## Use cases
+### Load useful functions to your shell script
+You can load useful functions from `oh-my-batch` this way:
+
+```bash
+omb misc export-shell-func > omb-func.sh && source omb-func.sh
+```
+
+This will load some useful functions to your shell script, for example, `checkpoint` function.
 
 ### Generate files from different combinations of parameters
 

{oh_my_batch-0.2.0 → oh_my_batch-0.2.1}/README.md

@@ -4,19 +4,33 @@
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/oh-my-batch)](https://pypi.org/project/oh-my-batch/)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/oh-my-batch)](https://pypi.org/project/oh-my-batch/)
 
-A simple tool to manipulate batch tasks designed for scientific computing community.
+A toolkit to manipulate batch tasks with command line. Designed for scientific computing community.
 
 ## Features
 * `omb combo`: generate folders/files from different combinations of parameters
 * `omb batch`: generate batch scripts from multiple working directories
 * `omb job`: track the state of job in job schedular
 
+## Shell Tips
+`oh-my-batch` is intended to help you implement computational workflows with shell scripts.
+To make the best use of `oh-my-batch`, you need to know some shell tips.
+
+* [Retry commands until success in shell script](https://stackoverflow.com/a/79191004/3099733)
+
 ## Install
 ```bash
 pip install oh-my-batch
 ```
 
 ## Use cases
+### Load useful functions to your shell script
+You can load useful functions from `oh-my-batch` this way:
+
+```bash
+omb misc export-shell-func > omb-func.sh && source omb-func.sh
+```
+
+This will load some useful functions to your shell script, for example, `checkpoint` function.
 
 ### Generate files from different combinations of parameters
 

{oh_my_batch-0.2.0 → oh_my_batch-0.2.1}/oh_my_batch/assets/functions.sh

@@ -1,6 +1,7 @@
+GREEN='\033[0;32m'
+NC='\033[0m'
 
 checkpoint() {
-    # Usage: checkpoint <flag_file> <command> [arg1] [arg2] ...
     local flag_file="$1"
     shift  # Remove the first argument so $@ contains only the command and its arguments
     if [ -f "$flag_file" ]; then
@@ -10,6 +11,7 @@ checkpoint() {
         local exit_code=$?
         if [ $exit_code -eq 0 ]; then
             local current_time=$(date '+%Y-%m-%d %H:%M:%S')
+            mkdir -p "$(dirname "$flag_file")"
             printf 'Command succeeded at %s\n' "$current_time" > "$flag_file"
             echo "Created flag file '$flag_file' with timestamp: $current_time"
         else
@@ -18,3 +20,16 @@ checkpoint() {
         fi
     fi
 }
+
+echo -e "${GREEN}Functiion: checkpoint${NC}"
+cat <<EOF
+Usage:
+    checkpoint <flag_file> <command> [arg1] [arg2] ...
+
+Set a flag file to indicate the completion of a command,
+so that it will not be executed again next time.
+
+Example:
+    checkpoint lmp.done lmp -in in.lmp
+
+EOF

{oh_my_batch-0.2.0 → oh_my_batch-0.2.1}/oh_my_batch/cli.py

@@ -23,6 +23,9 @@ class OhMyBatch:
     def job(self):
         return JobCli()
 
+    def misc(self):
+        from .misc import Misc
+        return Misc()
 
 def main():
     fire.Fire(OhMyBatch)

oh_my_batch-0.2.1/oh_my_batch/misc.py

@@ -0,0 +1,14 @@
+from .assets import get_asset
+
+class Misc:
+
+    def export_shell_func(self):
+        """
+        Export shell functions for batch scripts
+
+        For example, you can load them to you shell environment with the following command:
+            omb misc export-shell-func > omb-func.sh && source omb-func.sh
+        """
+        shell_func = get_asset('functions.sh')
+        with open(shell_func, 'r', encoding='utf-8') as f:
+            print(f.read())

{oh_my_batch-0.2.0 → oh_my_batch-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oh-my-batch"
-version = "0.2.0"
+version = "0.2.1"
 description = ""
 authors = ["weihong.xu <xuweihong.cn@gmail.com>"]
 license = "GPL"
@@ -11,7 +11,6 @@ packages = [{include = "oh_my_batch"}]
 python = "^3.8"
 fire = "^0.7.0"
 
-
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"