Merge pull request #1 from boegel/init

Author: bedroge

.github/workflows/test.yml

@@ -0,0 +1,39 @@
+# documentation: https://help.github.com/en/articles/workflow-syntax-for-github-actions
+name: Tests for eessi-cli
+on: [push, pull_request, workflow_dispatch]
+permissions:
+  contents: read # to fetch code (actions/checkout)
+jobs:
+  ubuntu-minimal:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python: ['3.6', '3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
+    steps:
+    - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+    - name: set up Python
+      uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
+      with:
+        python-version: ${{matrix.python}}
+
+    - name: Install eessi-cli
+      id: install
+      run: |
+        export PREFIX=/tmp/$USER/$GITHUB_SHA
+        pip install --prefix $PREFIX .
+        echo "export PATH=$PREFIX/bin:$PATH" >> ~/env
+        echo "export PYTHONPATH=$(ls -d $PREFIX/lib/python*/site-packages)" >> ~/env
+
+    - name: Test init (without EESSI mounted)
+      run: |
+        source ~/env
+        eessi init 2>&1 | grep "^ERROR: /cvmfs/software.eessi.io/versions/2023.06 does not exist"
+
+    - name: Mount EESSI
+      uses: eessi/github-action-eessi@e1f8f20638ea417a18d23ab29443ee34794ff900 # v3.1.0
+
+    - name: Test init
+      run: |
+        source ~/env
+        eessi init
+        eval "$(eessi init)"

.gitignore

@@ -0,0 +1,3 @@
+build
+dist
+*.egg-info

README.md

@@ -0,0 +1,41 @@
+# EESSI command line interface
+
+`eessi-cli` is a lightweight command line tool to help with using the European Environment for Scientific Software Installaitons (EESSI).
+
+* Website: https://eessi.io
+* Documentation: https://eessi.io/docs
+* GitHub: https:/github.com/EESSI
+
+
+## Installation
+
+### From PyPI
+
+```shell
+pip install eessi-cli
+```
+
+### From source
+
+```shell
+pip install .
+```
+
+
+## Usage
+
+### `init` subcommand
+
+Use `eval` and `eessi init` to prepare your session environment for using EESSI.
+
+```shell
+eval "$(eessi init)"
+```
+
+To see which commands this would evaluate, just run `eessi init`.
+
+
+## Design goals
+
+* Easy to install and use.
+* No dependencies beyond Python 3.6 (or newer) and its standard library.

eessi/__init__.py

@@ -0,0 +1,22 @@
+# license (SPDX): GPL-2.0-only
+# 
+# authors: Kenneth Hoste (Ghent University)
+
+import os
+import sys
+
+
+def init(_):
+    """
+    Initialize shell environment for using EESSI
+    """
+    eessi_path = os.path.join("/cvmfs", "software.eessi.io", "versions", "2023.06")
+    if os.path.exists(eessi_path):
+        print("# Commands to prepare your session environment for using EESSI (https://eessi.io/docs)")
+        print("# Use eval so commands below are used to set up your environment: eval \"$(eessi init)\"")
+        print("source /cvmfs/software.eessi.io/versions/2023.06/init/bash")
+    else:
+        sys.stderr.write(f"ERROR: {eessi_path} does not exist!\n")
+        eessi_docs_access = "https://eessi.io/docs/getting_access/is_eessi_accessible"
+        sys.stderr.write(f"See {eessi_docs_access} for information on how to get access to EESSI.\n")
+        sys.exit(1)

eessi/cli/init.py

@@ -0,0 +1,24 @@
+# license (SPDX): GPL-2.0-only
+# 
+# authors: Kenneth Hoste (Ghent University)
+
+import argparse
+import sys
+
+from eessi.cli.init import init
+
+
+def main():
+    parser = argparse.ArgumentParser(prog="eessi", description="EESSI command line utility")
+    subparsers = parser.add_subparsers(help="Available subcommands")
+
+    init_descr = "Initialize shell environment for using EESSI"
+    parser_init = subparsers.add_parser("init", description=init_descr, help=init_descr)
+    parser_init.set_defaults(func=init)
+
+    args = parser.parse_args(sys.argv[1:])
+    args.func(args)
+
+
+if __name__ == "__main__":
+    main()

eessi/cli/main.py

@@ -0,0 +1,14 @@
+from setuptools import setup
+
+setup(
+    name="eessi-cli",
+    version="0.0.1",
+    description="EESSI command line interface",
+    url="https://github.com/EESSI/eessi-cli",
+    install_requires=["click>=8.0"],
+    packages=["eessi/cli"],
+    entry_points={
+        "console_scripts": ["eessi=eessi.cli.main:main"],
+    },
+    python_requires=">=3.6",
+)