envstack 0.3.0__tar.gz → 0.4.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.3.0
+Version: 0.4.0
 Summary: Stacked environment variable management system.
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
@@ -22,8 +22,7 @@ a new `test` stack just create `test.env` files.
 
 > **Note:** envstack works best combined with [siteconf](https://github.com/rsgalloway/siteconf).
 
-Installation
-------------
+## Installation
 
 The easiest way to install:
 
@@ -35,7 +34,7 @@ $ pip install envstack
 
 Copy the default stack file
 [`stack.env`](https://github.com/rsgalloway/envstack/blob/master/stack.env)
-to your current working directory, the root of your project or /etc/envstack (the default location for env stack files).
+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
@@ -62,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:
@@ -112,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']
 ```
@@ -149,8 +149,7 @@ To see an environment stack on another platform:
 $ envstack <stack> -p <platform>
 ```
 
-Python API
-----------
+## Python API
 
 By default, `envstack.getenv` uses the resolved default env stack `stack` and can be
 a drop-in replacement for `os.getenv` 
@@ -176,14 +175,13 @@ The `init` function also updates the current environment for code that is not us
 'bar'
 ```
 
-Running Commands
-----------------
+## 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):
@@ -199,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.3.0 → envstack-0.4.0}/README.md

@@ -11,8 +11,7 @@ a new `test` stack just create `test.env` files.
 
 > **Note:** envstack works best combined with [siteconf](https://github.com/rsgalloway/siteconf).
 
-Installation
-------------
+## Installation
 
 The easiest way to install:
 
@@ -24,7 +23,7 @@ $ pip install envstack
 
 Copy the default stack file
 [`stack.env`](https://github.com/rsgalloway/envstack/blob/master/stack.env)
-to your current working directory, the root of your project or /etc/envstack (the default location for env stack files).
+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
@@ -51,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:
@@ -101,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']
 ```
@@ -138,8 +138,7 @@ To see an environment stack on another platform:
 $ envstack <stack> -p <platform>
 ```
 
-Python API
-----------
+## Python API
 
 By default, `envstack.getenv` uses the resolved default env stack `stack` and can be
 a drop-in replacement for `os.getenv` 
@@ -165,14 +164,13 @@ The `init` function also updates the current environment for code that is not us
 'bar'
 ```
 
-Running Commands
-----------------
+## 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):
@@ -188,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.3.0 → envstack-0.4.0}/lib/envstack/__init__.py

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

{envstack-0.3.0 → 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.3.0 → envstack-0.4.0}/lib/envstack/config.py

@@ -37,12 +37,33 @@ 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 env stacks

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

@@ -494,6 +494,38 @@ 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.
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.3.0
+Version: 0.4.0
 Summary: Stacked environment variable management system.
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
@@ -22,8 +22,7 @@ a new `test` stack just create `test.env` files.
 
 > **Note:** envstack works best combined with [siteconf](https://github.com/rsgalloway/siteconf).
 
-Installation
-------------
+## Installation
 
 The easiest way to install:
 
@@ -35,7 +34,7 @@ $ pip install envstack
 
 Copy the default stack file
 [`stack.env`](https://github.com/rsgalloway/envstack/blob/master/stack.env)
-to your current working directory, the root of your project or /etc/envstack (the default location for env stack files).
+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
@@ -62,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:
@@ -112,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']
 ```
@@ -149,8 +149,7 @@ To see an environment stack on another platform:
 $ envstack <stack> -p <platform>
 ```
 
-Python API
-----------
+## Python API
 
 By default, `envstack.getenv` uses the resolved default env stack `stack` and can be
 a drop-in replacement for `os.getenv` 
@@ -176,14 +175,13 @@ The `init` function also updates the current environment for code that is not us
 'bar'
 ```
 
-Running Commands
-----------------
+## 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):
@@ -199,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.3.0 → envstack-0.4.0}/setup.py

@@ -71,7 +71,7 @@ class PostInstallCommand(install):
 
 setup(
     name="envstack",
-    version="0.3.0",
+    version="0.4.0",
     description="Stacked environment variable management system.",
     long_description=long_description,
     long_description_content_type="text/markdown",