envstack 0.1.0__tar.gz

envstack-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.1
+Name: envstack
+Version: 0.1.0
+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
+Requires-Dist: PyYAML==6.0.2
+
+envstack
+========
+
+Stacked environment variable management system.
+
+Environment variables are declared in namespaced .env files using yaml syntax.
+The default namespace is `stack` and variables are declared in `stack.env`
+files.
+
+## Quickstart
+
+To create a new environment stack, create a new namespaced .env file.
+For example, here is a simple `thing.env` file (namespace is "thing"):
+
+```yaml
+all: &default
+  FOO: bar
+```
+
+To see the resolved environment for the `thing` stack, run:
+
+```bash
+$ envstack thing
+FOO 'bar'
+```
+
+Environment stacks are hierarchical, so values for `$FOO` defined in .env files lower
+in the filesystem (lower in scope) override those defined higher up (higher in scope):
+
+```
+/show/thing.env
+/show/seq/thing.env
+/show/seq/shot/thing.env
+/show/seq/shot/task/thing.env
+```
+
+Variables can reference other variables defined elsewhere (but cannot be circular):
+
+```yaml
+all: &default
+  BAR: $FOO
+```
+
+Variables can be platform specific (and inherit the defaults):
+
+```yaml
+linux:
+  <<: *default
+  HELLO: world
+```
+
+Environment files can include other namespaced environments:
+```yaml
+include: ['other']
+```
+
+Installation
+------------
+
+The easiest way to install:
+
+```bash
+$ pip install envstack
+```
+
+## Usage
+
+To see the default resolved environment for any given scope (directory):
+
+```bash
+$ envstack
+```
+
+To see the resolved environment for a given namespace.
+
+```bash
+$ envstack <namespace> [OPTIONS]
+```
+
+To resolve a $VAR declaration for a given namespace:
+
+```bash
+$ envstack <namespace> -r <VAR>
+```
+
+To trace where a $VAR declaration is being set:
+
+```bash
+$ envstack <namespace> -t <VAR>
+```
+
+To see an environment stack on another platform:
+
+```bash
+$ envstack <namespace> -p <platform>
+```

envstack-0.1.0/README.md

@@ -0,0 +1,96 @@
+envstack
+========
+
+Stacked environment variable management system.
+
+Environment variables are declared in namespaced .env files using yaml syntax.
+The default namespace is `stack` and variables are declared in `stack.env`
+files.
+
+## Quickstart
+
+To create a new environment stack, create a new namespaced .env file.
+For example, here is a simple `thing.env` file (namespace is "thing"):
+
+```yaml
+all: &default
+  FOO: bar
+```
+
+To see the resolved environment for the `thing` stack, run:
+
+```bash
+$ envstack thing
+FOO 'bar'
+```
+
+Environment stacks are hierarchical, so values for `$FOO` defined in .env files lower
+in the filesystem (lower in scope) override those defined higher up (higher in scope):
+
+```
+/show/thing.env
+/show/seq/thing.env
+/show/seq/shot/thing.env
+/show/seq/shot/task/thing.env
+```
+
+Variables can reference other variables defined elsewhere (but cannot be circular):
+
+```yaml
+all: &default
+  BAR: $FOO
+```
+
+Variables can be platform specific (and inherit the defaults):
+
+```yaml
+linux:
+  <<: *default
+  HELLO: world
+```
+
+Environment files can include other namespaced environments:
+```yaml
+include: ['other']
+```
+
+Installation
+------------
+
+The easiest way to install:
+
+```bash
+$ pip install envstack
+```
+
+## Usage
+
+To see the default resolved environment for any given scope (directory):
+
+```bash
+$ envstack
+```
+
+To see the resolved environment for a given namespace.
+
+```bash
+$ envstack <namespace> [OPTIONS]
+```
+
+To resolve a $VAR declaration for a given namespace:
+
+```bash
+$ envstack <namespace> -r <VAR>
+```
+
+To trace where a $VAR declaration is being set:
+
+```bash
+$ envstack <namespace> -t <VAR>
+```
+
+To see an environment stack on another platform:
+
+```bash
+$ envstack <namespace> -p <platform>
+```

envstack-0.1.0/lib/envstack/__init__.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2024, 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__ = """
+Stacked environment variable management system.
+"""
+
+__prog__ = "envstack"
+__version__ = "0.1.0"

envstack-0.1.0/lib/envstack/cli.py

@@ -0,0 +1,121 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2024, 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 command line interface for envstack.
+"""
+
+import os
+import sys
+import pprint
+import traceback
+
+from envstack import __version__
+from envstack import config
+from envstack.env import expandvars, load_environ, trace_var
+
+
+def parse_args():
+    """Command line argument parser."""
+
+    import argparse
+
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.RawTextHelpFormatter
+    )
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=f"envstack {__version__}",
+    )
+    parser.add_argument(
+        "namespace",
+        metavar="NAMESPACE",
+        nargs="?",
+        default=config.DEFAULT_NAMESPACE,
+        help="the namespace to use",
+    )
+    parser.add_argument(
+        "-p",
+        "--platform",
+        default=config.PLATFORM,
+        metavar="PLATFORM",
+        help="specify the platform to resolve variables for",
+    )
+    parser.add_argument(
+        "-r",
+        "--resolve",
+        metavar="VAR",
+        help="resolve an environment variable",
+    )
+    parser.add_argument(
+        "-t",
+        "--trace",
+        metavar="VAR",
+        help="trace where a variable is getting set",
+    )
+
+    args = parser.parse_args()
+
+    return args, parser
+
+
+def main():
+    """Main thread."""
+    args, _ = parse_args()
+
+    try:
+        if args.resolve:
+            env = load_environ(
+                args.namespace, environ=os.environ, platform=args.platform
+            )
+            var = env.get(args.resolve)
+            print(pprint.pformat(expandvars(var, env, recursive=True)))
+        elif args.trace:
+            path = trace_var(args.namespace, args.trace)
+            print("{0}: {1}".format(args.trace, path))
+        else:
+            env = load_environ(args.namespace, platform=args.platform, includes=True)
+            for k, v in env.items():
+                print(f"{k} {pprint.pformat(v)}")
+
+    except KeyboardInterrupt:
+        print("Stopping...")
+        return 2
+
+    except Exception:
+        traceback.print_exc()
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())

envstack-0.1.0/lib/envstack/config.py

@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+#
+# Copyright (c) 2024, 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 default configs and settings.
+"""
+
+import os
+import sys
+import platform
+
+DEBUG = os.getenv("DEBUG")
+DEFAULT_NAMESPACE = "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]
+USERNAME = os.getenv("USERNAME", os.getenv("USER"))
+
+# default location of the global environment directory by platform
+DEFAULT_ENV_DIR = os.getenv(
+    "DEFAULT_ENV_DIR",
+    {
+        "darwin": f"/etc/{DEFAULT_NAMESPACE}",
+        "linux": f"/etc/{DEFAULT_NAMESPACE}",
+        "windows": f"C:/ProgramData/{DEFAULT_NAMESPACE}",
+    }.get(PLATFORM),
+)