feat: create scripts to make champagne cli work OOTB

.github/workflows/build.yml

@@ -35,10 +35,16 @@ jobs:
           cache: "pip"
       - name: Install nextflow
         uses: nf-core/setup-nextflow@v1
-      - name: Install dependencies
+      - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip setuptools
-          mkdir -p tests/bin/
+          pip install click pyyaml cffconvert
+      - name: check out-of-the-box CLI script
+        run: |
+          bash bin/champagne --help
+          cd tests/cli && ../../bin/champagne --help
+      - name: Install champagne python package
+        run: |
           pip install .[dev,test]
           python -c 'from champagne.src.util import chmod_bins_exec; chmod_bins_exec()'
       - name: Check CLI basics

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## CHAMPAGNE development version
 
+- Create a script (`bin/champagne`) to provide an interface to the champagne CLI that works out-of-the-box without the need to install the python package with `pip`. (#180, @kelly-sovacool)
+  - However, any dependencies not in the Python Standard Library must be installed for this to work. See the dependencies list in `pyproject.toml`.
 - Fix configuration files for compatibility with using the GitHub repo as the source. (#173, @kelly-sovacool)
   - These equivalent commands now work:
     ```sh

bin/champagne

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+TOOLDIR=$(realpath $(dirname $(dirname ${BASH_SOURCE})))
+
+${TOOLDIR}/main.py "$@"

main.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+import os
+import re
+import sys
+
+# add script directory to the path to allow champagne CLI to work out-of-the-box
+# without the need to install it via pip first
+SCRIPT_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "src")
+sys.path.append(SCRIPT_DIR)
+from src.__main__ import main
+
+if (
+    __name__ == "__main__"
+):  # this block is adapted from the executable file created by `pip install`
+    sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0])
+    sys.exit(main())