Standalone support

Makefile

@@ -1,6 +1,6 @@
 check: lint test
 
-SOURCE_FILES=pybash.py test_pybash.py run.py
+SOURCE_FILES=pybash test_pybash.py run.py
 
 install:
 	pip install -e .
@@ -39,4 +39,7 @@ lint:
 shell:
 	source $(poetry env info --path)/bin/activate
 
+debug:
+	python -m ideas demo -a pybash.hook -s
+
 .PHONY: test clean

README.md

@@ -9,17 +9,25 @@ Streamline bash-command execution from python with a new syntax. It combines the
 
 For security and performance reasons, PyBash will NOT execute as shell, unless explicitly specified with a `$` instead of a single `>` before the command. While running commands as shell can be convenient, it can also spawn security risks if you're not too careful. If you're curious about the transformations, look at the [unit tests](test_pybash.py) for some quick examples.
 
-Note: this is a mainly experimental library. Consider the risks and test before using in prod.
+Note: this is a mainly experimental library.
 
-# Installation
+# Setup
+
+## As standalone transformer
 `pip install pybash`
 
-# Setup hook
+
 ```python
-import pybash
-pybash.add_hook()
+from pybash.transformer import transform
+
+transform(">echo hello world") # returns the python code for the bash command as string
 ```
 
+## As ideas hook
+`pip install "pybash[ideas]"`
+
+See [run.py](run.py) for an example.
+
 # Usage
 
 ### 1. Simple execution with output
@@ -149,5 +157,5 @@ cp_test()
 #### Demo
 `python run.py`
 
-#### Debugging
-`python -m ideas demo -a pybash -s` to view the transformed source code
+#### Debug
+`make debug` to view the transformed source code

demo.py

@@ -2,10 +2,10 @@
 
 # dynamic interpolation
 options = {'version': '-v', 'help': '-h'}
->git {{{options['help']}}}
+>git f{options['help']}
 
 namespace = "coffee"
->kubectl get pods {{{"--" + "-".join(['show', 'labels'])}}} --namespace {{{namespace}}}
+>kubectl get pods f{"--" + "-".join(['show', 'labels'])} --namespace f{namespace}
 
 # static interpolation
 git_command = "status"