fixed CKIT_HOME issue and added ckit gif

README.md

@@ -48,7 +48,7 @@ For more information, see the [documentation](https://fpgmaas.github.io/ckit/).
 _ckit_ can look for configuration in the following two locations:
 
 - In a `ckit.yaml` file in the current directory
-- In any `.yaml` file in the the global configuration directory, which is defaulted to `~/ckit`, but which can be overridden with the environment variable `ckit_HOME`.
+- In any `.yaml` file in the the global configuration directory, which is defaulted to `~/ckit`, but which can be overridden with the environment variable `CKIT_HOME`.
 
 An example `.yaml` file could look as follows:
 

ckit/command.py

@@ -5,6 +5,7 @@
 from dataclasses import dataclass
 
 import click
+import shlex
 
 
 @dataclass
@@ -56,7 +57,7 @@ def run(self):
         for command in cmd:
             if self.echo:
                 click.echo(command)
-            subprocess.run(self._expand_env_vars(command).split(" "))
+            subprocess.run(shlex.split(self._expand_env_vars(command)))
 
     @staticmethod
     def _expand_env_vars(command):

ckit/config/common.py

@@ -6,5 +6,5 @@ def get_global_commands_dir() -> Path:
     """
     Get the directory that contains the global command .yaml files.
     """
-    home = Path(os.environ["ckit_HOME"]) if "ckit_HOME" in os.environ else Path.home() / "ckit"
+    home = Path(os.environ["CKIT_HOME"]) if "CKIT_HOME" in os.environ else Path.home() / "ckit"
     return home

docs/configuration.md

@@ -3,7 +3,7 @@
 _ckit_ looks for configuration in the following two locations
 
 - From a `ckit.yaml` file in the current directory
-- From any `.yaml` file in the the global configuration directory, which is defaulted to `~/ckit`, but which can be overridden with the environment variable `ckit_HOME`.
+- From any `.yaml` file in the the global configuration directory, which is defaulted to `~/ckit`, but which can be overridden with the environment variable `CKIT_HOME`.
 
 Each `.yaml` file can contain one or more command groups, each containg one or more commands
 

tests/config/test_common.py

@@ -5,5 +5,5 @@
 
 
 def test_get_global_config_dir():
-    os.environ["ckit_HOME"] = "/some/dir"
+    os.environ["CKIT_HOME"] = "/some/dir"
     assert get_global_commands_dir() == Path("/some/dir")

tests/config/test_config_files_initiator.py

@@ -13,15 +13,15 @@ def test_config_files_initiator(mock_click, tmp_path: Path) -> None:
     mock_click.return_value = "y"
 
     with run_within_dir(tmp_path):
-        os.environ["ckit_HOME"] = str(tmp_path / "ckit_home")
+        os.environ["CKIT_HOME"] = str(tmp_path / "CKIT_HOME")
         ConfigFilesInitiator().init()
 
         assert "ckit.yaml" in os.listdir()
         with open("ckit.yaml", "rb") as f:
             command_groups_raw = yaml.load(f, Loader=yaml.loader.SafeLoader)
             assert "example" in command_groups_raw
 
-        assert "ckit.yaml" in os.listdir("ckit_home")
-        with open("ckit_home/ckit.yaml", "rb") as f:
+        assert "ckit.yaml" in os.listdir("CKIT_HOME")
+        with open("CKIT_HOME/ckit.yaml", "rb") as f:
             command_groups_raw = yaml.load(f, Loader=yaml.loader.SafeLoader)
             assert "example" in command_groups_raw