envsub 0.2.0__cp313-cp313-win_amd64.whl

envsub/__init__.py

@@ -0,0 +1,5 @@
+"""A fast and simple environment variable substitution."""
+
+from .envsub import sub
+
+__all__ = ["sub"]

envsub/__main__.py

@@ -0,0 +1,27 @@
+"""
+A module executable from the shell, it read stdin, it writes std out.
+
+```bash
+$ echo "db: ${DATABASE_URL-sqlite:///}" > config.yml
+$ cat config.yml | python -m envsub
+db: sqlite:///
+```
+"""
+
+import sys
+from .envsub import sub
+
+
+def main():
+    cnt = 0
+    while True:
+        cnt += 1
+        res = sub(sys.stdin).read()
+        if not res:
+            return
+        else:
+            print(res, end="")
+
+
+if __name__ == "__main__":
+    main()

envsub/envsub.pyi

@@ -0,0 +1,12 @@
+"""Pyo3 binding interface definition."""
+
+from typing import TextIO
+
+
+def sub(downstream: TextIO) -> TextIO:
+    """
+    Replace all the envar from a downstream and return an upstream.
+
+    :downstream: A file-like object that provides text input.
+    :return: A file-like object with environment variables replaced.
+    """

envsub-0.2.0.dist-info/METADATA

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: envsub
+Version: 0.2.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing
+Classifier: Typing :: Typed
+Requires-Dist: furo>=2024.5.6 ; extra == 'docs'
+Requires-Dist: linkify-it-py>=2.0.3,<3 ; extra == 'docs'
+Requires-Dist: myst-parser>=3.0.0,<4 ; python_full_version < '3.10' and extra == 'docs'
+Requires-Dist: myst-parser>=4.0.0,<5 ; python_full_version >= '3.10' and extra == 'docs'
+Requires-Dist: sphinx>=7.0.1,<8 ; extra == 'docs'
+Requires-Dist: sphinx-autodoc2>=0.5.0,<1 ; extra == 'docs'
+Provides-Extra: docs
+License-File: LICENSE
+Summary: A text preprocessing tool with environment variable substitution.
+Keywords: environment,substitution,variables
+Author: Guillaume Gauvrit <guillaume@gauvr.it>
+Author-email: Guillaume Gauvrit <guillaume@gauvr.it>
+License: MIT License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://mardiros.github.io/envsub/
+Project-URL: Documentation, https://mardiros.github.io/mardiros/envsub
+Project-URL: Repository, https://github.com/mardiros/envsub.git
+Project-URL: Issues, https://github.com/mardiros/envsub/issues
+Project-URL: Changelog, https://mardiros.github.io/mardiros/envsub/changelog.html
+
+# envsub
+
+[![Documentation](https://github.com/mardiros/envsub/actions/workflows/publish-doc.yml/badge.svg)](https://mardiros.github.io/envsub/)
+[![Continuous Integration](https://github.com/mardiros/envsub/actions/workflows/tests.yml/badge.svg)](https://github.com/mardiros/envsub/actions/workflows/tests.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a63ad49239e41de4f6b7/maintainability)](https://codeclimate.com/github/mardiros/envsub/maintainability)
+
+**envsub** is a text preprocessing tool that performs environment variable
+substitution in files, with support for default values. Written in Rust and
+callable from Python, it provides a fast and reliable way to inject environment
+variables into text files during runtime.
+
+## Features
+
+- Environment variable substitution in any text file.
+- Support for default values when environment variables are missing.
+- Fast performance with Rust under the hood, accessible from Python.
+
+## Installation
+
+```bash
+pip install envsub
+```
+
+
+## Usage
+
+
+### envsub api
+
+envsub comes with a `sub` method that text a `io.TextIO` and return
+a `io.TextIO` containing the replaced variable.
+
+Basic usage:
+
+```python
+from envsub import sub
+
+
+with open("/path/to/file", "r") as downstream:
+    with sub(downstream) as upstream:
+        upstream.read()
+
+```
+
+
+When it is usefull.
+
+``envsub`` is made for replacing a set of variable inside a configuration
+file from envisonment variable, its feet well with confifuration file format.
+
+Example with json:
+
+
+```python
+import json
+from envsub import sub
+
+with open("/path/to/file.json", "r") as downstream:
+    with sub(downstream) as upstream:
+        data = json.load(upstream)
+
+```
+
+
+### Substitution format
+
+envsubst subsitute variable format that are curly-braced, like in bash.
+
+```json
+{"hello": "${NAME}"}
+```
+
+> ⚠️ **Warning:**
+>
+> The variable stay in the same line, no `\n` are permitted.**
+>
+> This will **not** work:
+> {"hello": "${
+>      NAME
+>    }"
+> }
+>
+
+
+#### Default value:
+
+If the environment variable is not present, no substitution will be made,
+it means than in the previous example, `${NAME}` will stay in the read value.
+
+Alternatively, a default value can be set in the variable, using a `-` value.
+
+
+```json
+{"hello": "${NAME-world}"}
+```
+
+In this case the final result will be `{"hello": "world"}`.
+
+
+
+## Alternatives
+
+Similar tools exists, but did not find any good one in python.
+
+The envsub lib has been created to replace non existing tool like
+[a8m/envsubst](https://github.com/a8m/envsubst) a Go binary that
+update the GNU envsubst that do not support default values.
+

envsub-0.2.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+envsub-0.2.0.dist-info/METADATA,sha256=taQmisa0xpWEXwZDCZmx9GDCH_bxDaZtp-C96nmgqDs,4146
+envsub-0.2.0.dist-info/WHEEL,sha256=XsgF4V7TnSmJTnuU62xP5hrnZJ48WDEWrpRztgXGPlM,96
+envsub-0.2.0.dist-info/entry_points.txt,sha256=g12l_7WuetC36PiIyzLD2yY0bMu0WGCwrgUbRga0YdY,36
+envsub-0.2.0.dist-info/licenses/LICENSE,sha256=D_2CSBqhb-ro_uhPo0uQgF_93O8-hhN3L6oDWfbsa-c,1101
+envsub/envsub.pyi,sha256=Gyes_TF_20u2dtefaPQ-FW91XXFw0Jb3RlBRruPla4k,337
+envsub/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+envsub/__init__.py,sha256=yDqf0SKSFCQlj8HQ0eaTL6ShdC4cWGKjV78eVZUUYeY,108
+envsub/__main__.py,sha256=_o1j9NjjlDSKjjEL84wms6G1EZKiB3UXC53-uScDbbg,477
+envsub/envsub.cp313-win_amd64.pyd,sha256=e3pjJLikYq9qLzzNhiZ_VjUPz6BbkFelW0tp4eABoNk,283648
+envsub-0.2.0.dist-info/RECORD,,

envsub-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.8.2)
+Root-Is-Purelib: false
+Tag: cp313-cp313-win_amd64

envsub-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+envsub=envsub:sub

envsub-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2025, Guillaume Gauvrit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.