init commit

Author: Carme, Pamy

README.md

@@ -0,0 +1,104 @@
+Stack Config
+===============================
+
+version number: 0.1.0
+author: ScienceLogic
+
+Overview
+--------
+
+Merge and compile jinja2 template compose files
+
+Installation / Usage
+--------------------
+
+To install use pip:
+
+    $ pip install stackconfig
+
+
+Or clone the repo:
+
+    $ git clone https://github.com/Sciencelogic/stackconfig.git
+    $ python setup.py install
+
+
+Development
+-----------
+1. Fork
+2. Set Dev Environment
+```shell script
+pip install -r dev_requirements.txt
+pip install -r requirements.txt
+pip install -e .
+git checkout -b feature-more-cool-stuff
+```
+Test
+----
+```shell script
+# run tests using tox
+tox
+# run tests with pytest
+pytest
+```
+Version
+-------
+```
+bumpversion major  # major release
+or
+bumpversion minor  # minor release
+or
+bumpversion patch  # hotfix release
+
+git push origin release-n.n.0
+or
+git push origin hotfix-x.x.n
+```
+Contributing
+------------
+
+TBD
+
+
+
+Example
+-------
+
+```shell
+$ stackconfig --help
+Usage: stackconfig [OPTIONS]
+
+Options:
+  -f, --file PATH        docker-compose file to be merged. Accept multiple
+                         arguments.
+  -o, --output PATH      Output path for the final docker-compose file
+                         [default: /tmp/docker-compose-20220425-16-49-16.yml]
+  -d, --j2data PATH      Yaml file that contains variables to render the
+                         provided jinja2 template.
+  -t, --j2template PATH  Jinja2 template that needs to be a valid docker-
+                         compose file after being rendered.
+  --version TEXT         Set valid version for the final docker-compose file
+  --help                 Show this message and exit.
+
+```
+
+```
+$ stackconfig -f docker-compose.yml -f docker-compose-verrideyml -t docker-compose-valid-template.yml.j2 -d data_file.yml --version 3.8 -o docker-compose.yml
+```
+
+Example using python code
+-------------------------
+```python
+from stackconfig.stackconfig import StackConfigCompose, render_jijnja2_compose
+
+jinja_env = {}
+yml_compiled_files = render_jijnja2_compose(['/tmp/docker-compose.yml.j2',
+                                    '/tmp/docker-compose-override-yml.j2'],
+                                   data_file='/tmp/data_file.yml',
+                                   data_dict=jinja_env)
+# valid docker-compose files can be append, as all of them 
+yml_compiled_files.append("/tmp/docker-copmose-override2.yml")
+stack_config = StackConfigCompose(yml_compiled_files, '/tmp/docker-compose-output.yml')
+stack_config.merge_stack_compose()
+
+```