envstack 0.9.2__tar.gz → 0.9.4__tar.gz

{envstack-0.9.2/lib/envstack.egg-info → envstack-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.9.2
+Version: 0.9.4
 Summary: Stacked environment variable management system
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
@@ -112,7 +112,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):
@@ -371,21 +373,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]
@@ -614,6 +616,7 @@ The following environment variables are used to help manage functionality:
 | DEFAULT_ENV_STACK | Name of the default environment stack (default) |
 | ENVPATH | Colon-separated paths to search for stack files |
 | IGNORE_MISSING | Ignore missing stack files when resolving environments |
+| INTERACTIVE | Run one-off commands in an interactive shell |
 | STACK | Stores the name of the current environment stack |
 
 # Tests

{envstack-0.9.2 → envstack-0.9.4}/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]
@@ -590,6 +592,7 @@ The following environment variables are used to help manage functionality:
 | DEFAULT_ENV_STACK | Name of the default environment stack (default) |
 | ENVPATH | Colon-separated paths to search for stack files |
 | IGNORE_MISSING | Ignore missing stack files when resolving environments |
+| INTERACTIVE | Run one-off commands in an interactive shell |
 | STACK | Stores the name of the current environment stack |
 
 # Tests

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/__init__.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #
@@ -34,6 +34,6 @@ Stacked environment variable management system.
 """
 
 __prog__ = "envstack"
-__version__ = "0.9.2"
+__version__ = "0.9.4"
 
 from envstack.env import clear, init, revert, save  # noqa: F401

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/cli.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #
@@ -37,6 +37,7 @@ import argparse
 import re
 import sys
 import traceback
+from typing import List
 
 from envstack import __version__, config
 from envstack.env import (
@@ -147,15 +148,14 @@ 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",
@@ -221,6 +221,12 @@ def parse_args():
         metavar="SCOPE",
         help="search scope for environment stack files",
     )
+    parser.add_argument(
+        "-u",
+        "--unresolved",
+        action="store_true",
+        help="dump unresolved environment variables to stdout",
+    )
     parser.add_argument(
         "-r",
         "--resolve",
@@ -254,9 +260,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 envstack shell... CTRL+D to exit")
+
+    name = (namespace or [config.DEFAULT_NAMESPACE])[:]
+    shell = EnvshellWrapper(name)
+    return shell.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]")
@@ -426,13 +443,16 @@ def main():
             for source in env.sources:
                 print(source.path)
 
-        else:
+        elif args.unresolved:
             env = load_environ(
                 args.namespace, platform=args.platform, encrypt=args.encrypt
             )
             for k, v in sorted(env.items(), key=lambda x: str(x[0])):
                 print(f"{k}={v}")
 
+        else:
+            return envshell(args.namespace)
+
     except KeyboardInterrupt:
         print("Stopping...")
         return 2

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/config.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/encrypt.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #
@@ -43,6 +43,7 @@ from envstack.logger import log
 
 # 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
@@ -50,7 +51,6 @@ try:
     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 @@ class FernetEncryptor(object):
             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 @@ class FernetEncryptor(object):
         :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,
     }

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/env.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #
@@ -36,6 +36,7 @@ Contains functions and classes for processing scoped .env files.
 import os
 import re
 import string
+from collections import defaultdict
 from pathlib import Path
 
 import yaml  # noqa
@@ -77,7 +78,7 @@ class Source(object):
         :param path: path to .env file.
         """
         self.path = path
-        self.data = {}
+        self.data = defaultdict(dict)
 
     def __eq__(self, other):
         if not isinstance(other, Source):
@@ -126,7 +127,10 @@ class Source(object):
 
     def write(self, filepath: str = None):
         """Writes the source data to the .env file."""
-        util.dump_yaml(filepath or self.path, self.data)
+        try:
+            util.dump_yaml(filepath or self.path, self.data)
+        except Exception as err:
+            logger.log.exception("Failed to write %s: %s", filepath or self.path, err)
 
 
 class EnvVar(string.Template, str):

envstack-0.9.4/lib/envstack/envshell.py

@@ -0,0 +1,143 @@
+#!/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.
+#
+
+"""
+Contains envshell wrapper class.
+
+Goal: drop the user into an interactive shell *without* sourcing their usual
+shell rc files, so prompt vars (PS1/PROMPT) set by envstack can survive.
+
+Notes:
+- You can override the detected shell with ENVSTACK_SHELL.
+  Examples:
+    ENVSTACK_SHELL=/bin/zsh envstack --shell
+    ENVSTACK_SHELL=pwsh envstack --shell
+"""
+
+import os
+from pathlib import Path
+from typing import List
+
+from . import config
+from .wrapper import Wrapper
+
+
+def _basename(p: str) -> str:
+    """Return the lowercase basename of a path, robustly."""
+    try:
+        return Path(p).name.lower()
+    except Exception:
+        return os.path.basename(p).lower()
+
+
+def _detect_shell_argv() -> List[str]:
+    """
+    Return argv list for a *clean* interactive shell.
+    """
+    shell = os.environ.get("ENVSTACK_SHELL", config.SHELL)
+
+    if os.name == "nt":
+        # Prefer COMSPEC if it looks like cmd.exe; otherwise allow pwsh/powershell.
+        comspec = os.environ.get("COMSPEC", "cmd.exe")
+
+        # If user explicitly asked for pwsh/powershell, honor it.
+        base = _basename(shell)
+        if base in ("pwsh", "pwsh.exe"):
+            return [shell, "-NoExit", "-NoProfile"]
+        if base in ("powershell", "powershell.exe"):
+            return [shell, "-NoExit", "-NoProfile"]
+
+        # Otherwise use cmd.exe, with /K to keep it open.
+        # (Even if config.SHELL returned "cmd", use COMSPEC so we get the real path.)
+        return [comspec, "/K"]
+
+    # POSIX shells
+    base = _basename(shell)
+
+    # bash: skip /etc/profile, ~/.bash_profile, ~/.bashrc, but stay interactive
+    if base == "bash":
+        return [shell, "--noprofile", "--norc", "-i"]
+
+    # zsh: -f skips zshrcs; -i for interactive
+    if base == "zsh":
+        return [shell, "-f", "-i"]
+
+    # tcsh/csh: -f skips rc; interactive by default when attached to a tty
+    if base in ("tcsh", "csh"):
+        return [shell, "-f"]
+
+    # fish: --no-config skips config.fish; interactive by default
+    if base == "fish":
+        return [shell, "--no-config"]
+
+    # Fallback: try interactive flag if common; otherwise just exec the shell
+    # (Most shells become interactive when connected to a tty anyway.)
+    return [shell, "-i"]
+
+
+class EnvshellWrapper(Wrapper):
+    """A wrapper that spawns an interactive shell with the environment set."""
+
+    def __init__(self, *args, **kwargs):
+        super(EnvshellWrapper, self).__init__(*args, **kwargs)
+        self.shell = False  # exec the shell directly
+
+    def executable(self):
+        """
+        Kept for interface compatibility. The actual argv is produced in
+        get_subprocess_command().
+        """
+        return ""
+
+    def get_subprocess_command(self, env):
+        """
+        Override to return argv list for subprocess.Popen(..., shell=False).
+        """
+        return _detect_shell_argv()
+
+    def get_shell_prompt(self) -> str:
+        """
+        Return the environment variable that controls the shell prompt and its
+        desired value.
+        """
+        if os.name == "nt":
+            return ("PROMPT", "$E[32m(${ENV:=${STACK}})$E[0m $P$G ")
+        else:
+            return ("PS1", "\[\e[32m\](${ENV:=${STACK}})\[\e[0m\] \w\$ ")
+
+    def get_subprocess_env(self):
+        """
+        Override to inject PS1/PROMPT if not already set.
+        """
+        prompt_env, prompt_value = self.get_shell_prompt()
+        if prompt_env not in self.env:
+            self.env[prompt_env] = prompt_value
+        return super().get_subprocess_env()

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/exceptions.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/logger.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/node.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #
@@ -328,7 +328,7 @@ class CustomDumper(yaml.SafeDumper):
                 node.style = '"%s"' % node.value
             elif node.value and node.value[-1] == ":":
                 node.style = '"%s"' % node.value
-            elif ": " in node.value:
+            elif ": " in str(node.value):
                 node.style = '"%s"' % node.value
 
     def quote_vars(self, node: yaml.Node):

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/path.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #

{envstack-0.9.2 → envstack-0.9.4}/lib/envstack/util.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Copyright (c) 2024-2025, Ryan Galloway (ryan@rsgalloway.com)
 #
@@ -604,17 +604,12 @@ def validate_yaml(file_path: str):
 
     :param file_path: Path to the YAML file to validate.
     """
-    required_keys = {"all", "darwin", "linux", "windows"}
-
     try:
         with open(file_path, "r") as stream:
             data = yaml.safe_load(stream.read())
             # data = yaml.load(stream.read(), Loader=CustomLoader)
         if not isinstance(data, dict):
             raise yaml.YAMLError("invalid data structure")
-        missing_keys = required_keys - data.keys()
-        if missing_keys:
-            raise yaml.YAMLError(f"missing keys: {', '.join(sorted(missing_keys))}")
         return data
     except OSError as e:
         print(e)