envstack 0.5.2__tar.gz → 0.5.3__tar.gz

envstack-0.5.3/LICENSE

@@ -0,0 +1,12 @@
+envstack
+
+Copyright (c) 2024, Ryan Galloway (ryan@rsgalloway.com)
+All rights reserved.
+
+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 author 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.

{envstack-0.5.2 → envstack-0.5.3}/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.5.2
+Version: 0.5.3
 Summary: Stacked environment variable management system.
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
 Author-email: ryan@rsgalloway.com
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: PyYAML>=5.1.2
 
 envstack
@@ -217,18 +218,49 @@ $ 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):
+## Shells
 
+In order to set an environment stack in your current shell, the stack must be
+sourced (that's because Python processes and subshells cannot alter the
+environment of the parent process).
+
+To source the environment in your current shell, create an alias that sources
+the output of the `--export` command:
+
+#### bash
 ```bash
-$ source <(envstack --export)
-$ alias stack='source <(envstack $ARG --export)'
+alias envstack-set='source <(envstack "$1" --export)';
+```
+
+#### cmd
+```cmd
+doskey envstack-set=for /f "usebackq" %%i in (`envstack --export $*`) do %%i
 ```
 
-In Windows command prompt:
+Then you can set the environment stack in your shell with the `envstack-set`
+command. To clear the environment in your current shell, create an alias that
+sources the output of the `--clear` command:
+
+#### bash
+```bash
+alias envstack-clear='source <(envstack "$1" --clear)';
+```
+
+#### cmd
+```cmd
+doskey envstack-clear=for /f "usebackq" %%i in (`envstack --clear $*`) do %%i
+```
+
+Create a function for convenience that does both in one command:
+
+#### bash
+```bash
+envstack-init() { envstack-clear "$1"; envstack-set "$1"; }
+```
 
+#### cmd
 ```cmd
-for /f "usebackq" %i in (`envstack --export`) do %i
+doskey envstack-init=envstack-clear $* & envstack-set $*
 ```
 
 ## Config

{envstack-0.5.2 → envstack-0.5.3}/README.md

@@ -207,18 +207,49 @@ $ 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):
+## Shells
 
+In order to set an environment stack in your current shell, the stack must be
+sourced (that's because Python processes and subshells cannot alter the
+environment of the parent process).
+
+To source the environment in your current shell, create an alias that sources
+the output of the `--export` command:
+
+#### bash
 ```bash
-$ source <(envstack --export)
-$ alias stack='source <(envstack $ARG --export)'
+alias envstack-set='source <(envstack "$1" --export)';
+```
+
+#### cmd
+```cmd
+doskey envstack-set=for /f "usebackq" %%i in (`envstack --export $*`) do %%i
 ```
 
-In Windows command prompt:
+Then you can set the environment stack in your shell with the `envstack-set`
+command. To clear the environment in your current shell, create an alias that
+sources the output of the `--clear` command:
+
+#### bash
+```bash
+alias envstack-clear='source <(envstack "$1" --clear)';
+```
+
+#### cmd
+```cmd
+doskey envstack-clear=for /f "usebackq" %%i in (`envstack --clear $*`) do %%i
+```
+
+Create a function for convenience that does both in one command:
+
+#### bash
+```bash
+envstack-init() { envstack-clear "$1"; envstack-set "$1"; }
+```
 
+#### cmd
 ```cmd
-for /f "usebackq" %i in (`envstack --export`) do %i
+doskey envstack-init=envstack-clear $* & envstack-set $*
 ```
 
 ## Config

{envstack-0.5.2 → envstack-0.5.3}/lib/envstack/__init__.py

@@ -34,7 +34,7 @@ Stacked environment variable management system.
 """
 
 __prog__ = "envstack"
-__version__ = "0.5.2"
+__version__ = "0.5.3"
 
 from envstack.env import Env
 from envstack.env import getenv, init, load_file

{envstack-0.5.2 → envstack-0.5.3}/lib/envstack/cli.py

@@ -73,10 +73,15 @@ def parse_args():
         default=config.DEFAULT_NAMESPACE,
         help="the environment stack to use (default '%s')" % config.DEFAULT_NAMESPACE,
     )
+    parser.add_argument(
+        "--clear",
+        action="store_true",
+        help="generate shell unset commands for a given stack",
+    )
     parser.add_argument(
         "--export",
         action="store_true",
-        help="generate export commands for the current shell",
+        help="generate shell export commands for a given stack",
     )
     parser.add_argument(
         "-p",
@@ -133,6 +138,8 @@ def main():
             sources = build_sources(args.namespace)
             for source in sources:
                 print(source)
+        elif args.clear:
+            print(export(args.namespace, config.SHELL, clear=True))
         elif args.export:
             print(export(args.namespace, config.SHELL))
         elif command:

{envstack-0.5.2 → envstack-0.5.3}/lib/envstack/env.py

@@ -504,33 +504,50 @@ def expandvars(var, env=None, recursive=False):
     return EnvVar(var).expand(env, recursive=recursive)
 
 
-def export(name, shell="bash", resolve=False, scope=None):
+def export(name, shell="bash", resolve=False, scope=None, clear=False):
     """Returns environment commands that can be sourced.
 
        $ source <(envstack --export)
 
-    List of shell names: bash, tcsh, cmd, pwsh
+    or to clear existing values:
+
+        $ source <(envstack --clear)
+
+    List of shell names: bash, sh, 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
+    :param name: stack namespace.
+    :param shell: name of shell (default: bash).
+    :param resolve: resolve values (default: True).
+    :param scope: environment scope (default: cwd).
+    :param clear: clear existing values (default: False).
+    :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))
+        if shell == "bash" or shell == "sh":
+            if clear:
+                expList.append(f"unset {k}")
+            else:
+                expList.append(f'export {k}="{v}"')
         elif shell == "tcsh":
-            expList.append('setenv {0}:"{1}"'.format(k, v))
+            if clear:
+                expList.append(f"unsetenv {k}")
+            else:
+                expList.append(f'setenv {k}:"{v}"')
         elif shell == "cmd":
-            expList.append('set {0}="{1}"'.format(k, v))
+            if clear:
+                expList.append(f"set {k}=")
+            else:
+                expList.append(f'set {k}="{v}"')
         elif shell == "pwsh":
-            expList.append('$env:{0}="{1}"'.format(k, v))
+            if clear:
+                expList.append(f"Remove-Item Env:{k}")
+            else:
+                expList.append(f'$env:{k}="{v}"')
     expList.sort()
     exp = "\n".join(expList)
     return exp

{envstack-0.5.2 → envstack-0.5.3}/lib/envstack.egg-info/PKG-INFO

@@ -1,11 +1,12 @@
 Metadata-Version: 2.1
 Name: envstack
-Version: 0.5.2
+Version: 0.5.3
 Summary: Stacked environment variable management system.
 Home-page: http://github.com/rsgalloway/envstack
 Author: Ryan Galloway
 Author-email: ryan@rsgalloway.com
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: PyYAML>=5.1.2
 
 envstack
@@ -217,18 +218,49 @@ $ 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):
+## Shells
 
+In order to set an environment stack in your current shell, the stack must be
+sourced (that's because Python processes and subshells cannot alter the
+environment of the parent process).
+
+To source the environment in your current shell, create an alias that sources
+the output of the `--export` command:
+
+#### bash
 ```bash
-$ source <(envstack --export)
-$ alias stack='source <(envstack $ARG --export)'
+alias envstack-set='source <(envstack "$1" --export)';
+```
+
+#### cmd
+```cmd
+doskey envstack-set=for /f "usebackq" %%i in (`envstack --export $*`) do %%i
 ```
 
-In Windows command prompt:
+Then you can set the environment stack in your shell with the `envstack-set`
+command. To clear the environment in your current shell, create an alias that
+sources the output of the `--clear` command:
+
+#### bash
+```bash
+alias envstack-clear='source <(envstack "$1" --clear)';
+```
+
+#### cmd
+```cmd
+doskey envstack-clear=for /f "usebackq" %%i in (`envstack --clear $*`) do %%i
+```
+
+Create a function for convenience that does both in one command:
+
+#### bash
+```bash
+envstack-init() { envstack-clear "$1"; envstack-set "$1"; }
+```
 
+#### cmd
 ```cmd
-for /f "usebackq" %i in (`envstack --export`) do %i
+doskey envstack-init=envstack-clear $* & envstack-set $*
 ```
 
 ## Config

{envstack-0.5.2 → envstack-0.5.3}/lib/envstack.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 setup.py
 stack.env

{envstack-0.5.2 → envstack-0.5.3}/setup.py

@@ -74,7 +74,7 @@ class PostInstallCommand(install):
 
 setup(
     name="envstack",
-    version="0.5.2",
+    version="0.5.3",
     description="Stacked environment variable management system.",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -85,7 +85,7 @@ setup(
     packages=find_packages("lib"),
     entry_points={
         "console_scripts": [
-            "envstack = envstack.cli:main",
+            "envstack=envstack.cli:main",
         ],
     },
     install_requires=[