Merge pull request #79 from rsgalloway/v0.9.3

Version 0.9.3

Author: rsgalloway

README.md

@@ -88,7 +88,9 @@ STACK=default
 If you are not seeing the above output, make sure the `default.env` stack file
 is in `${ENVPATH}` or the current working directory.
 
-> NOTE: The name of the current stack will always be stored in `${STACK}`
+> NOTE: The name of the current stack will always be stored in `${STACK}`.
+
+ENV is the tier, STACK is the namespace.
 
 Environments can be combined, or stacked, in order of priority (variables
 defined in stacks flow from higher scope to lower scope, left to right):
@@ -347,21 +349,21 @@ Then use `keys.env` to encrypt any other environment files:
 $ ./keys.env -- envstack -eo encrypted.env
 ```
 
-To decrypt, add `keys` to the env stack:
+To decrypt, run the command inside the `keys` environment again:
 
 ```bash
-$ envstack keys encrypted -r HELLO
+$ ./keys.env -- envstack encrypted -r HELLO
 HELLO=world
 ```
 
-Or run the command inside the `keys` environment like this:
+Or add `keys` to the env stack:
 
 ```bash
-$ ./keys.env -- envsatck encrypted -r HELLO
+$ envstack keys encrypted -r HELLO
 HELLO=world
 ```
 
-Or include `keys` in environments to automatically decrypt:
+Or automatically include `keys`:
 
 ```yaml
 include: [keys]

bin/envshell

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+#
+# Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  - Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  - Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  - Neither the name of the software nor the names of its contributors
+#    may be used to endorse or promote products derived from this software
+#    without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+
+__doc__ = """
+Contains a simple executable for the envstack cli.py module.
+"""
+
+import re
+import sys
+from envstack.cli import envshell
+
+if __name__ == "__main__":
+    sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0])
+    sys.exit(envshell(sys.argv[1:]))

bin/envshell.bat

@@ -0,0 +1,2 @@
+@echo off
+python %~dp0\envshell %*

env/default.env

@@ -10,9 +10,12 @@ all: &all
 darwin:
   <<: *all
   ROOT: /Volumes/pipe
+  PS1: '\[\e[32m\](${ENV})\[\e[0m\] \w\$ '
 linux:
   <<: *all
   ROOT: /mnt/pipe
+  PS1: '\[\e[32m\](${ENV})\[\e[0m\] \w\$ '
 windows:
   <<: *all
-  ROOT: "X:/pipe"
+  ROOT: //tools/pipe
+  PROMPT: $E[32m(${ENV})$E[0m $P$G

env/hello.env

@@ -5,7 +5,10 @@ all: &all
   PYEXE: /usr/bin/python
 darwin:
   <<: *all
+  PS1: '\[\e[33m\](${STACK})\[\e[0m\] \w\$ '
 linux:
   <<: *all
+  PS1: '\[\e[33m\](${STACK})\[\e[0m\] \w\$ '
 windows:
-  <<: *all
+  <<: *all
+  PROMPT: $E[33m(${ENV})$E[0m $P$G

env/project.env

@@ -0,0 +1,14 @@
+#!/usr/bin/env envstack
+include: [default]
+all: &all
+  ENV: ${STACK:=${ENV}}
+  DEPLOY_ROOT: ${ROOT}/${ENV}
+  ENVPATH: ${ROOT}/${ENV}/env:${ROOT}/prod/env
+  PATH: ${ROOT}/${ENV}/bin:${ROOT}/prod/bin:${PATH}
+  PYTHONPATH: ${ROOT}/${ENV}/lib/python:${ROOT}/prod/lib/python:${PYTHONPATH}
+darwin:
+  <<: *all
+linux:
+  <<: *all
+windows:
+  <<: *all

env/test.env

@@ -34,6 +34,6 @@
 """
 
 __prog__ = "envstack"
-__version__ = "0.9.2"
+__version__ = "0.9.3"
 
 from envstack.env import clear, init, revert, save  # noqa: F401

lib/envstack/__init__.py

@@ -37,6 +37,7 @@
 import re
 import sys
 import traceback
+from typing import List
 
 from envstack import __version__, config
 from envstack.env import (
@@ -147,20 +148,24 @@ def parse_args():
         action="version",
         version=f"envstack {__version__}",
     )
-    group = parser.add_mutually_exclusive_group(required=False)
-    group.add_argument(
+    parser.add_argument(
         "namespace",
         metavar="STACK",
         nargs="*",
         default=[config.DEFAULT_NAMESPACE],
         help="the environment stacks to use",
     )
-    group.add_argument(
+    parser.add_argument(
         "-b",
         "--bare",
         action="store_true",
         help="create a bare environment",
     )
+    parser.add_argument(
+        "--shell",
+        action="store_true",
+        help="drop into a shell with the environment loaded",
+    )
     encrypt_group = parser.add_argument_group("encryption options")
     encrypt_group.add_argument(
         "-e",
@@ -254,9 +259,20 @@ def parse_args():
     return args, args_after_dash
 
 
+def envshell(namespace: List[str] = None):
+    """Run a shell in the given environment stack."""
+    from .envshell import EnvshellWrapper
+
+    print("\U0001F680 Launching envshell... CTRL+D to exit")
+
+    name = (namespace or [config.DEFAULT_NAMESPACE])[:]
+    envshell = EnvshellWrapper(name)
+    return envshell.launch()
+
+
 def whichenv():
     """Entry point for the whichenv command line tool. Finds {VAR}s."""
-    from envstack.util import findenv
+    from .util import findenv
 
     if len(sys.argv) != 2:
         print("Usage: whichenv [VAR]")
@@ -276,6 +292,9 @@ def main():
         if command:
             return run_command(command, args.namespace)
 
+        elif args.shell:
+            return envshell(args.namespace)
+
         elif args.keygen:
             from envstack.encrypt import generate_keys
 

lib/envstack/cli.py

@@ -43,14 +43,14 @@
 
 # cryptography and _rust dependency may not be available everywhere
 # ImportError: DLL load failed while importing _rust: Module not found.
+Fernet = None
 try:
     import cryptography.exceptions
     from cryptography.fernet import Fernet, InvalidToken
     from cryptography.hazmat.primitives import padding
     from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
 except ImportError as err:
     log.debug("cryptography module not available: %s", err)
-    Fernet = None
 
 
 class Base64Encryptor(object):
@@ -78,7 +78,7 @@ class FernetEncryptor(object):
     KEY_VAR_NAME = "ENVSTACK_FERNET_KEY"
 
     def __init__(self, key: str = None, env: dict = os.environ):
-        if key:
+        if key and Fernet:
             self.key = Fernet(key)
         else:
             self.key = self.get_key(env)
@@ -90,7 +90,8 @@ def generate_key(csl):
             key = Fernet.generate_key()
             return key.decode()
         else:
-            log.error("Fernet encryption not available")
+            log.debug("Fernet encryption not available")
+        return ""
 
     def get_key(self, env: dict = os.environ):
         """Load the encryption key from the environment `env`.
@@ -99,7 +100,7 @@ def get_key(self, env: dict = os.environ):
         :return: encryption key.
         """
         key = env.get(self.KEY_VAR_NAME)
-        if key:
+        if key and Fernet:
             return Fernet(key)
         return key
 
@@ -313,12 +314,11 @@ def generate_keys():
 
     :returns: Dictionary containing Fernet and AES-GCM keys.
     """
-    from envstack.node import Base64Node
 
     symmetric_key = AESGCMEncryptor.generate_key()
     fernet_key = FernetEncryptor.generate_key()
 
     return {
-        AESGCMEncryptor.KEY_VAR_NAME: Base64Node(symmetric_key),
-        FernetEncryptor.KEY_VAR_NAME: Base64Node(fernet_key),
+        AESGCMEncryptor.KEY_VAR_NAME: symmetric_key,
+        FernetEncryptor.KEY_VAR_NAME: fernet_key,
     }