envstack 0.2.6__tar.gz → 0.4.0__tar.gz

{envstack-0.2.6 → envstack-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.2.6
+Version: 0.4.0
 Summary: Stacked environment variable management system.
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
@@ -20,10 +20,9 @@ The default stack is `stack` and variables are declared in `stack.env`
 files. You can create any new stack by creating new `.env` files, e.g. creating
 a new `test` stack just create `test.env` files.
 
-Envstack works best combined with [siteconf](https://github.com/rsgalloway/siteconf).
+> **Note:** envstack works best combined with [siteconf](https://github.com/rsgalloway/siteconf).
 
-Installation
-------------
+## Installation
 
 The easiest way to install:
 
@@ -35,9 +34,15 @@ $ pip install envstack
 
 Copy the default stack file
 [`stack.env`](https://github.com/rsgalloway/envstack/blob/master/stack.env)
-to your current working directory, or the root of your project. This is the default
-environment stack. Running the `envstack` command should show you the resolved
-environment for your platform:
+to your current working directory, the root of your project or `/etc/envstack` (the default location for envstack files, or `C:/ProgramData/envstack` on Windows).
+
+
+```bach
+cp stack.env /etc/envstack
+```
+
+The `stack` namespace is the default environment stack. Running the `envstack` command
+should show you the resolved environment for your platform:
 
 ```bash
 $ envstack
@@ -56,7 +61,7 @@ Modify the environment stack by updating `stack.env` or by creating new contextu
 You can execute any command inside the default stacked environment like this:
 
 ```bash
-$ enstack -- <command>
+$ envstack -- <command>
 ```
 
 For example:
@@ -106,7 +111,8 @@ linux:
   HELLO: world
 ```
 
-Environment files can include other namespaced environments:
+Environment files can include other namespaced environments (all stacks inherit the default stack.env automatically).
+
 ```yaml
 include: ['other']
 ```
@@ -143,14 +149,39 @@ To see an environment stack on another platform:
 $ envstack <stack> -p <platform>
 ```
 
-Running Commands
-----------------
+## Python API
+
+By default, `envstack.getenv` uses the resolved default env stack `stack` and can be
+a drop-in replacement for `os.getenv` 
+
+```python
+>>> import envstack
+>>> envstack.getenv("HELLO")
+'world'
+```
+
+To use a different stack, use the `init` function:
+
+```python
+>>> envstack.init("thing")
+>>> envstack.getenv("FOO")
+'bar'
+```
+
+The `init` function also updates the current environment for code that is not using envstack:
+
+```python
+>>> os.getenv("FOO")
+'bar'
+```
+
+## Running Commands
 
 To run any command line executable inside of an environment stack, where `<command>`
 is the command to run:
 
 ```bash
-$ enstack <stack> -- <command>
+$ envstack <stack> -- <command>
 ```
 
 For example, running python in the default stack (reading from the default `stack.env` file):
@@ -166,3 +197,26 @@ Same command but using the "thing" stack"
 $ envstack thing -- python -c "import os; print(os.environ['FOO'])"
 bar
 ```
+
+To source the environment in your current shell, source the output of --export (and create
+an alias for convenience):
+
+```bash
+$ source <(envstack --export)
+$ alias esinit='source <(envstack $ARG --export)'
+```
+
+In Windows command prompt:
+
+```cmd
+for /f "usebackq" %i in (`envstack --export`) do %i
+```
+
+## Config
+
+Default config settings are in the config.py module. The following environment variables are supported:
+
+| Variable            | Description |
+|---------------------|-------------|
+| $DEFAULT_ENV_DIR    | the folder containing the default env stack files |
+| $DEFAULT_ENV_STACK  | the name of the default env stack namespace (default "stack") |

{envstack-0.2.6 → envstack-0.4.0}/README.md

@@ -9,10 +9,9 @@ The default stack is `stack` and variables are declared in `stack.env`
 files. You can create any new stack by creating new `.env` files, e.g. creating
 a new `test` stack just create `test.env` files.
 
-Envstack works best combined with [siteconf](https://github.com/rsgalloway/siteconf).
+> **Note:** envstack works best combined with [siteconf](https://github.com/rsgalloway/siteconf).
 
-Installation
-------------
+## Installation
 
 The easiest way to install:
 
@@ -24,9 +23,15 @@ $ pip install envstack
 
 Copy the default stack file
 [`stack.env`](https://github.com/rsgalloway/envstack/blob/master/stack.env)
-to your current working directory, or the root of your project. This is the default
-environment stack. Running the `envstack` command should show you the resolved
-environment for your platform:
+to your current working directory, the root of your project or `/etc/envstack` (the default location for envstack files, or `C:/ProgramData/envstack` on Windows).
+
+
+```bach
+cp stack.env /etc/envstack
+```
+
+The `stack` namespace is the default environment stack. Running the `envstack` command
+should show you the resolved environment for your platform:
 
 ```bash
 $ envstack
@@ -45,7 +50,7 @@ Modify the environment stack by updating `stack.env` or by creating new contextu
 You can execute any command inside the default stacked environment like this:
 
 ```bash
-$ enstack -- <command>
+$ envstack -- <command>
 ```
 
 For example:
@@ -95,7 +100,8 @@ linux:
   HELLO: world
 ```
 
-Environment files can include other namespaced environments:
+Environment files can include other namespaced environments (all stacks inherit the default stack.env automatically).
+
 ```yaml
 include: ['other']
 ```
@@ -132,14 +138,39 @@ To see an environment stack on another platform:
 $ envstack <stack> -p <platform>
 ```
 
-Running Commands
-----------------
+## Python API
+
+By default, `envstack.getenv` uses the resolved default env stack `stack` and can be
+a drop-in replacement for `os.getenv` 
+
+```python
+>>> import envstack
+>>> envstack.getenv("HELLO")
+'world'
+```
+
+To use a different stack, use the `init` function:
+
+```python
+>>> envstack.init("thing")
+>>> envstack.getenv("FOO")
+'bar'
+```
+
+The `init` function also updates the current environment for code that is not using envstack:
+
+```python
+>>> os.getenv("FOO")
+'bar'
+```
+
+## Running Commands
 
 To run any command line executable inside of an environment stack, where `<command>`
 is the command to run:
 
 ```bash
-$ enstack <stack> -- <command>
+$ envstack <stack> -- <command>
 ```
 
 For example, running python in the default stack (reading from the default `stack.env` file):
@@ -155,3 +186,26 @@ Same command but using the "thing" stack"
 $ envstack thing -- python -c "import os; print(os.environ['FOO'])"
 bar
 ```
+
+To source the environment in your current shell, source the output of --export (and create
+an alias for convenience):
+
+```bash
+$ source <(envstack --export)
+$ alias esinit='source <(envstack $ARG --export)'
+```
+
+In Windows command prompt:
+
+```cmd
+for /f "usebackq" %i in (`envstack --export`) do %i
+```
+
+## Config
+
+Default config settings are in the config.py module. The following environment variables are supported:
+
+| Variable            | Description |
+|---------------------|-------------|
+| $DEFAULT_ENV_DIR    | the folder containing the default env stack files |
+| $DEFAULT_ENV_STACK  | the name of the default env stack namespace (default "stack") |

{envstack-0.2.6 → envstack-0.4.0}/lib/envstack/__init__.py

@@ -34,4 +34,6 @@ Stacked environment variable management system.
 """
 
 __prog__ = "envstack"
-__version__ = "0.2.6"
+__version__ = "0.4.0"
+
+from envstack.env import getenv, init

{envstack-0.2.6 → envstack-0.4.0}/lib/envstack/cli.py

@@ -40,7 +40,7 @@ import sys
 import traceback
 
 from envstack import __version__, config
-from envstack.env import build_sources, expandvars, load_environ, trace_var
+from envstack.env import build_sources, expandvars, export, load_environ, trace_var
 from envstack.wrapper import run_command
 
 
@@ -75,6 +75,11 @@ def parse_args():
         default=config.DEFAULT_NAMESPACE,
         help="the environment stack to use (default '%s')" % config.DEFAULT_NAMESPACE,
     )
+    parser.add_argument(
+        "--export",
+        action="store_true",
+        help="generate export commands for the current shell",
+    )
     parser.add_argument(
         "-p",
         "--platform",
@@ -123,6 +128,8 @@ def main():
             sources = build_sources(args.namespace)
             for source in sources:
                 print(source)
+        elif args.export:
+            print(export(args.namespace, config.SHELL))
         elif command:
             return run_command(args.namespace, command)
         else:

{envstack-0.2.6 → envstack-0.4.0}/lib/envstack/config.py

@@ -37,20 +37,41 @@ import os
 import platform
 import sys
 
+
+def detect_shell():
+    """Detect the current shell."""
+    if PLATFORM == "windows":
+        comspec = os.environ.get("ComSpec")
+        if comspec:
+            if "cmd.exe" in comspec:
+                return "cmd"
+            elif "powershell.exe" in comspec:
+                return "pwsh"
+        else:
+            return "unknown"
+    else:
+        shell = os.environ.get("SHELL")
+        if shell:
+            return shell.split("/")[-1]
+        else:
+            return "unknown"
+
+
 DEBUG = os.getenv("DEBUG")
-DEFAULT_NAMESPACE = "stack"
+DEFAULT_NAMESPACE = os.getenv("DEFAULT_ENV_STACK", "stack")
 LOG_LEVEL = int(os.environ.get("LOG_LEVEL", 20))
 ON_POSIX = "posix" in sys.builtin_module_names
 PLATFORM = platform.system().lower()
 PYTHON_VERSION = sys.version_info[0]
+SHELL = detect_shell()
 USERNAME = os.getenv("USERNAME", os.getenv("USER"))
 
-# default location of the global environment directory by platform
+# default location of the global env stacks
 DEFAULT_ENV_DIR = os.getenv(
     "DEFAULT_ENV_DIR",
     {
-        "darwin": f"/etc/{DEFAULT_NAMESPACE}",
-        "linux": f"/etc/{DEFAULT_NAMESPACE}",
-        "windows": f"C:/ProgramData/{DEFAULT_NAMESPACE}",
+        "darwin": "/etc/envstack",
+        "linux": "/etc/envstack",
+        "windows": "C:/ProgramData/envstack",
     }.get(PLATFORM),
 )

{envstack-0.2.6 → envstack-0.4.0}/lib/envstack/env.py

@@ -356,31 +356,44 @@ def clear_file_cache():
     load_file_cache = {}
 
 
-def safe_eval(value):
-    """Returns template value preserving original class.
-    Useful for preserving nested values in wrappers.
-    """
+def decode_value(value):
+    """Returns a decoded value that's been encoded by a wrapper.
 
-    from envstack.wrapper import decode_value
+    Decoding encoded environments can be tricky. For example, it must account for path
+    templates that include curly braces, e.g. path templates string like this must be
+    preserved:
 
-    try:
-        from ast import literal_eval
+        '/path/with/{variable}'
 
-        eval_func = literal_eval
-    except ImportError:
-        # warning: security issue
-        eval_func = eval
-
-    if type(value) == str:
-        try:
-            return eval_func(value)
-        except Exception:
-            try:
-                return eval_func(decode_value(value))
-            except Exception:
-                return value
-
-    return value
+    :param value: wrapper encoded env value
+    :returns: decoded value
+    """
+    # TODO: find a better way to encode/decode wrapper envs
+    return (
+        str(value)
+        .replace("'[", "[")
+        .replace("]'", "]")
+        .replace('"[', "[")
+        .replace(']"', "]")
+        .replace('"{"', "{'")
+        .replace('"}"', "'}")
+        .replace("'{'", "{'")
+        .replace("'}'", "'}")
+    )
+
+
+def encode(env, resolved=True):
+    """Returns environment as a dict with str encoded key/values for passing to
+    wrapper subprocesses.
+
+    :param env: `Env` instance or os.environ.
+    :param resolved: fully resolve values (default=True).
+    :returns: dict with bytestring key/values.
+    """
+    c = lambda v: str(v)
+    if resolved:
+        return dict((c(k), c(expandvars(v, env))) for k, v in env.items())
+    return dict((c(k), c(v)) for k, v in env.items())
 
 
 def build_sources(
@@ -481,6 +494,47 @@ def expandvars(var, env=None, recursive=False):
     return EnvVar(var).expand(env, recursive=recursive)
 
 
+def export(name, shell="bash", resolve=False, scope=None):
+    """Returns environment commands that can be sourced.
+
+       $ source <(envstack --export)
+
+    List of shell names: bash, tcsh, cmd, pwsh
+    (see output of config.detect_shell()).
+
+    :param name: stack namespace
+    :param shell: name of shell (default: bash)
+    :param resolve: resolve values (default: True)
+    :param scope: environment scope (default: cwd)
+    :returns: shell commands as string
+    """
+    env = load_environ(name, scope=scope)
+    expList = list()
+    for k, v in env.items():
+        if resolve:
+            v = expandvars(v, env, recursive=False)
+        if shell == "bash":
+            expList.append('export {0}="{1}"'.format(k, v))
+        elif shell == "tcsh":
+            expList.append('setenv {0}:"{1}"'.format(k, v))
+        elif shell == "cmd":
+            expList.append('set {0}="{1}"'.format(k, v))
+        elif shell == "pwsh":
+            expList.append('$env:{0}="{1}"'.format(k, v))
+    expList.sort()
+    exp = "\n".join(expList)
+    return exp
+
+
+def init(name=config.DEFAULT_NAMESPACE):
+    """Initializes the environment for a given namespace.
+
+    :param name: namespace (basename of env files).
+    """
+    env = load_environ(name)
+    os.environ.update(encode(env))
+
+
 def load_environ(
     name=config.DEFAULT_NAMESPACE,
     sources=None,
@@ -562,6 +616,31 @@ def load_file(path):
     return data
 
 
+def safe_eval(value):
+    """Returns template value preserving original class.
+    Useful for preserving nested values in wrappers.
+    """
+
+    try:
+        from ast import literal_eval
+
+        eval_func = literal_eval
+    except ImportError:
+        # warning: security issue
+        eval_func = eval
+
+    if type(value) == str:
+        try:
+            return eval_func(value)
+        except Exception:
+            try:
+                return eval_func(decode_value(value))
+            except Exception:
+                return value
+
+    return value
+
+
 def trace_var(name, var, scope=None):
     """Traces where a var is getting set for a given name.
 

{envstack-0.2.6 → envstack-0.4.0}/lib/envstack/wrapper.py

@@ -38,47 +38,7 @@ import subprocess
 import traceback
 
 from envstack import logger
-from envstack.env import expandvars, load_environ
-
-
-def decode_value(value):
-    """Returns a decoded value that's been encoded by a wrapper.
-
-    Decoding encoded environments can be tricky. For example, it must account for path
-    templates that include curly braces, e.g. path templates string like this must be
-    preserved:
-
-        '/path/with/{variable}'
-
-    :param value: wrapper encoded env value
-    :returns: decoded value
-    """
-    # TODO: find a better way to encode/decode wrapper envs
-    return (
-        str(value)
-        .replace("'[", "[")
-        .replace("]'", "]")
-        .replace('"[', "[")
-        .replace(']"', "]")
-        .replace('"{"', "{'")
-        .replace('"}"', "'}")
-        .replace("'{'", "{'")
-        .replace("'}'", "'}")
-    )
-
-
-def encode(env, resolved=True):
-    """Returns environment as a dict with str encoded key/values for passing to
-    wrapper subprocesses.
-
-    :param env: `Env` instance or os.environ.
-    :param resolved: fully resolve values (default=True).
-    :returns: dict with bytestring key/values.
-    """
-    c = lambda v: str(v)
-    if resolved:
-        return dict((c(k), c(expandvars(v, env))) for k, v in env.items())
-    return dict((c(k), c(v)) for k, v in env.items())
+from envstack.env import encode, expandvars, load_environ
 
 
 def to_args(cmd):

{envstack-0.2.6 → envstack-0.4.0}/lib/envstack.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.2.6
+Version: 0.4.0
 Summary: Stacked environment variable management system.
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
@@ -20,10 +20,9 @@ The default stack is `stack` and variables are declared in `stack.env`
 files. You can create any new stack by creating new `.env` files, e.g. creating
 a new `test` stack just create `test.env` files.
 
-Envstack works best combined with [siteconf](https://github.com/rsgalloway/siteconf).
+> **Note:** envstack works best combined with [siteconf](https://github.com/rsgalloway/siteconf).
 
-Installation
-------------
+## Installation
 
 The easiest way to install:
 
@@ -35,9 +34,15 @@ $ pip install envstack
 
 Copy the default stack file
 [`stack.env`](https://github.com/rsgalloway/envstack/blob/master/stack.env)
-to your current working directory, or the root of your project. This is the default
-environment stack. Running the `envstack` command should show you the resolved
-environment for your platform:
+to your current working directory, the root of your project or `/etc/envstack` (the default location for envstack files, or `C:/ProgramData/envstack` on Windows).
+
+
+```bach
+cp stack.env /etc/envstack
+```
+
+The `stack` namespace is the default environment stack. Running the `envstack` command
+should show you the resolved environment for your platform:
 
 ```bash
 $ envstack
@@ -56,7 +61,7 @@ Modify the environment stack by updating `stack.env` or by creating new contextu
 You can execute any command inside the default stacked environment like this:
 
 ```bash
-$ enstack -- <command>
+$ envstack -- <command>
 ```
 
 For example:
@@ -106,7 +111,8 @@ linux:
   HELLO: world
 ```
 
-Environment files can include other namespaced environments:
+Environment files can include other namespaced environments (all stacks inherit the default stack.env automatically).
+
 ```yaml
 include: ['other']
 ```
@@ -143,14 +149,39 @@ To see an environment stack on another platform:
 $ envstack <stack> -p <platform>
 ```
 
-Running Commands
-----------------
+## Python API
+
+By default, `envstack.getenv` uses the resolved default env stack `stack` and can be
+a drop-in replacement for `os.getenv` 
+
+```python
+>>> import envstack
+>>> envstack.getenv("HELLO")
+'world'
+```
+
+To use a different stack, use the `init` function:
+
+```python
+>>> envstack.init("thing")
+>>> envstack.getenv("FOO")
+'bar'
+```
+
+The `init` function also updates the current environment for code that is not using envstack:
+
+```python
+>>> os.getenv("FOO")
+'bar'
+```
+
+## Running Commands
 
 To run any command line executable inside of an environment stack, where `<command>`
 is the command to run:
 
 ```bash
-$ enstack <stack> -- <command>
+$ envstack <stack> -- <command>
 ```
 
 For example, running python in the default stack (reading from the default `stack.env` file):
@@ -166,3 +197,26 @@ Same command but using the "thing" stack"
 $ envstack thing -- python -c "import os; print(os.environ['FOO'])"
 bar
 ```
+
+To source the environment in your current shell, source the output of --export (and create
+an alias for convenience):
+
+```bash
+$ source <(envstack --export)
+$ alias esinit='source <(envstack $ARG --export)'
+```
+
+In Windows command prompt:
+
+```cmd
+for /f "usebackq" %i in (`envstack --export`) do %i
+```
+
+## Config
+
+Default config settings are in the config.py module. The following environment variables are supported:
+
+| Variable            | Description |
+|---------------------|-------------|
+| $DEFAULT_ENV_DIR    | the folder containing the default env stack files |
+| $DEFAULT_ENV_STACK  | the name of the default env stack namespace (default "stack") |

{envstack-0.2.6 → envstack-0.4.0}/setup.py

@@ -43,27 +43,35 @@ with open(os.path.join(here, "README.md")) as f:
 class PostInstallCommand(install):
     """Custom post-installation for copying stack.env."""
 
-    def run(self):
-        install.run(self)
-        home_dir = os.getenv("HOME") or os.getenv("USERPROFILE")
+    def install_default_stack(self):
+        """Copy the default stack.env file to the default location."""
+        from envstack.config import DEFAULT_ENV_DIR
 
-        if not home_dir:
-            print("Error: unable to determine home directory.")
-            return
+        if not os.path.isdir(DEFAULT_ENV_DIR):
+            os.makedirs(DEFAULT_ENV_DIR)
 
         source = os.path.join(os.path.dirname(__file__), "stack.env")
-        destination = os.path.join(home_dir, "stack.env")
+        destination = os.path.join(DEFAULT_ENV_DIR, "stack.env")
 
         if os.path.exists(source):
+            print(f"Copying {source} to {destination}")
             shutil.copy(source, destination)
-            print(f"Copied {source} to {destination}")
         else:
-            print(f"{source} not found")
+            print(f"{source} not found)")
+
+    def run(self):
+        """Run the default install and copy the default stack.env file."""
+        install.run(self)
+
+        try:
+            self.install_default_stack()
+        except Exception as e:
+            print(f"Error copying stack.env: {e}")
 
 
 setup(
     name="envstack",
-    version="0.2.6",
+    version="0.4.0",
     description="Stacked environment variable management system.",
     long_description=long_description,
     long_description_content_type="text/markdown",