rename to k8t, add licensing

Author: AFriemann

.envrc

@@ -0,0 +1,3 @@
+source_up
+
+pre-commit install-hooks

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
+  - repo: git://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+      - id: check-merge-conflict
+  - repo: [email protected]:Yelp/detect-secrets
+    rev: v0.12.5
+    hooks:
+      - id: detect-secrets
+        args: ['--baseline', '.secrets.baseline']
+  - repo: git://github.com/Lucas-C/pre-commit-hooks.git
+    rev: v1.1.7
+    hooks:
+      - id: insert-license
+        files: \.py$

LICENSE.txt

@@ -1,5 +1,7 @@
-LICENSE.txt
+ISC License
 
-:Author: Aljosha Friemann
-:Email: [email protected]
-:Date: 2019-10-08 18:29
+Copyright 2019 FL Fintech E GmbH
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -1,4 +1,6 @@
-# kinja
+# k8t
+
+*Pronounced Katie [ˈkeɪti]*
 
 Simple cluster and environment specific aware templating for kubernetes manifests.
 
@@ -21,41 +23,41 @@ check out https://github.com/ClarkSource/k8s-cd-poc
 Create a new project folder with a cluster directory and an empty defaults file
 
 ```
-$ kinja new project foobar
+$ k8t new project foobar
 ```
 
 Create a new cluster
 
 ```
-$ kinja new cluster A
+$ k8t new cluster A
 ```
 
 Create a new environment
 
 ```
-$ kinja new environment staging A
-$ kinja new environment production A
+$ k8t new environment staging A
+$ k8t new environment production A
 ```
 Setup secrets on SSM
 
 ```
-$ kinja edit config
+$ k8t edit config
 secrets:
   provider: ssm
 ```
 
 Specify prefixes for SSM secrets
 
 ```
-$ kinja edit config --cluster A --environment staging
+$ k8t edit config --cluster A --environment staging
 secrets:
   prefix: "staging/application"```
 ```
 
 Values can be easily added/modified in the same way
 
 ```
-$ kinja edit values --cluster Ano creds to it anyway or dont know where to get
+$ k8t edit values --cluster Ano creds to it anyway or dont know where to get
 ```
 
 A typical setup should look something like this
@@ -100,13 +102,13 @@ A typical setup should look something like this
 While validation is done before generating, templates can be validated for environment files easily.
 
 ```
-$ kinja validate
+$ k8t validate
 ```
 
 To validate for clusters/environments the usual options can be used
 
 ```
-$ kinja validate -c A -e production
+$ k8t validate -c A -e production
 ```
 
 ### generate files
@@ -115,10 +117,10 @@ The **--cluster** flag will load variables from a directory. By default the file
 loaded, however an environment can be specified with **--environment**.
 
 ```
-$ kinja gen -c A -e staging
+$ k8t gen -c A -e staging
 ```
 
-Additionally kinja will attempt to load a file **defaults.yaml** in the root directory. This way a set of default
+Additionally k8t will attempt to load a file **defaults.yaml** in the root directory. This way a set of default
 variables can be specified and selectively overriden via cluster and environment.
 
 Additional values can be given via flag **--value-file** in the form of a file or **--value KEY VALUE**, both can be
@@ -127,7 +129,7 @@ supplied multiple times.
 Variables will be merged via deep merging. Default merge strategy is left-to-right. For the merge order see the output of
 
 ```
-$ kinja --help
+$ k8t --help
 ```
 
 ### Overriding templates

k8t/__init__.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+# vim:fenc=utf-8
+#
+# Copyright © 2018 Clark Germany GmbH
+
+__version__ = '0.0.1'
+__license__ = """Copyright 2019 FL Fintech E GmbH
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE."""

kinja/__main__.py renamed to k8t/__main__.py

@@ -3,6 +3,6 @@
 #
 # Copyright © 2018 Clark Germany GmbH
 
-from kinja.cli import main
+from k8t.cli import main
 
 main()

kinja/cli.py renamed to k8t/cli.py

@@ -9,19 +9,20 @@
 
 import click
 import coloredlogs
-from kinja.clusters import get_cluster_path, list_clusters, load_cluster
-from kinja.config import load_configuration
-from kinja.engine import build
-from kinja.environments import list_environments
-from kinja.templates import analyze, validate
-from kinja.util import MERGE_METHODS, deep_merge, touch
-from kinja.values import load_defaults, load_value_file
+from k8t import __license__, __version__
+from k8t.clusters import get_cluster_path, list_clusters, load_cluster
+from k8t.config import load_configuration
+from k8t.engine import build
+from k8t.environments import list_environments
+from k8t.templates import analyze, validate
+from k8t.util import MERGE_METHODS, deep_merge, touch
+from k8t.values import load_defaults, load_value_file
 from simple_tools.interaction import confirm
 from termcolor import colored
 
 
 def check_directory(path: str) -> bool:
-    return os.path.exists(os.path.join(path, '.ktpl'))
+    return os.path.exists(os.path.join(path, '.k8t'))
 
 
 @click.group()
@@ -35,6 +36,16 @@ def root(debug):
         logging.WARN if not debug else logging.INFO)
 
 
+@root.command(name='version')
+def print_version():
+    print(f"k8t {__version__}")
+
+
+@root.command(name='license')
+def print_license():
+    print(__license__)
+
+
 @root.command(name='validate')
 @click.option('-m', '--method', type=click.Choice(MERGE_METHODS), default='ltr', show_default=True)
 @click.option('--cluster', '-c')
@@ -147,7 +158,7 @@ def new_project(directory):
             sys.exit(1)
         os.makedirs(directory, exist_ok=True)
 
-    touch(os.path.join(directory, '.ktpl'))
+    touch(os.path.join(directory, '.k8t'))
 
     os.makedirs(os.path.join(directory, 'clusters'), exist_ok=True)
     os.makedirs(os.path.join(directory, 'templates'), exist_ok=True)

kinja/clusters.py renamed to k8t/clusters.py

@@ -6,10 +6,10 @@
 import os
 from typing import Any, Dict, List
 
-from kinja.environments import load_environment
-from kinja.logger import LOGGER
-from kinja.util import deep_merge
-from kinja.values import load_value_file
+from k8t.environments import load_environment
+from k8t.logger import LOGGER
+from k8t.util import deep_merge
+from k8t.values import load_value_file
 
 
 def list_clusters(path: str) -> List[str]:

kinja/config.py renamed to k8t/config.py

@@ -7,7 +7,8 @@
 from typing import Any, Dict
 
 import yaml
-from kinja.util import merge
+
+from k8t.util import merge
 
 
 def load_configuration(path: str, cluster: str, environment: str) -> dict:

kinja/engine.py renamed to k8t/engine.py

@@ -6,11 +6,12 @@
 import os
 
 from jinja2 import Environment, FileSystemLoader
-from kinja.clusters import get_cluster_path
-from kinja.environments import get_environment_path
-from kinja.logger import LOGGER
-from kinja.secrets import get_secret
-from kinja.util import b64decode, b64encode, hashf, random_password
+
+from k8t.clusters import get_cluster_path
+from k8t.environments import get_environment_path
+from k8t.logger import LOGGER
+from k8t.secrets import get_secret
+from k8t.util import b64decode, b64encode, hashf, random_password
 
 
 def build(path: str, cluster: str, environment: str):

kinja/environments.py renamed to k8t/environments.py

@@ -6,7 +6,7 @@
 import os
 from typing import Any, Dict, List
 
-from kinja.values import load_value_file
+from k8t.values import load_value_file
 
 
 def list_environments(path: str) -> List[str]:

kinja/logger.py renamed to k8t/logger.py

@@ -4,7 +4,8 @@
 # Author: Aljosha Friemann <[email protected]>
 
 import boto3
-from kinja.logger import LOGGER
+
+from k8t.logger import LOGGER
 
 
 def ssm(key: str) -> str:

kinja/secret_providers.py renamed to k8t/secret_providers.py

@@ -3,8 +3,8 @@
 # Copyright © 2019 Clark Germany GmbH
 # Author: Aljosha Friemann <[email protected]>
 
-from kinja import secret_providers
-from kinja.config import load_configuration
+from k8t import secret_providers
+from k8t.config import load_configuration
 
 
 def get_secret(key: str, path: str, cluster: str, environment: str) -> str:

kinja/secrets.py renamed to k8t/secrets.py

@@ -7,7 +7,8 @@
 from typing import Set, Tuple
 
 from jinja2 import meta, nodes
-from kinja.logger import LOGGER
+
+from k8t.logger import LOGGER
 
 PROHIBITED_VARIABLE_NAMES = ['namespace']
 

kinja/templates.py renamed to k8t/templates.py

@@ -11,7 +11,7 @@
 from functools import reduce
 from typing import Any
 
-from kinja.logger import LOGGER
+from k8t.logger import LOGGER
 
 try:
     from secrets import choice

kinja/util.py renamed to k8t/util.py

@@ -6,7 +6,8 @@
 import os
 
 import yaml
-from kinja.logger import LOGGER
+
+from k8t.logger import LOGGER
 
 
 def load_value_file(path: str):

kinja/values.py renamed to k8t/values.py

@@ -1,12 +1,12 @@
 [metadata]
-name = kinja
+name = k8t
 version = 0.0.1
-url = https://github.com/ClarkSource/kinja
+url = https://github.com/ClarkSource/k8t
 author = Aljosha Friemann
 author_email = [email protected]
 description = Kubernetes templating engine based on Jinja2
 long_description = file: README.rst
-long_description_content_type = text/x-rst
+long_description_content_type = text/markdown
 keywords = kubernetes, jinja
 platforms = linux
 license_file = LICENSE.txt

kinja/__init__.py

@@ -3,5 +3,5 @@
 from setuptools import setup
 
 setup(
-    entry_points={'console_scripts': ['kinja=kinja.cli:main']}
+    entry_points={'console_scripts': ['k8t=k8t.cli:main']}
 )

setup.cfg

@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
-# vim:fenc=utf-8
 #
 # Copyright © 2018 Clark Germany GmbH
+# Author: Aljosha Friemann <[email protected]>

setup.py

@@ -3,7 +3,7 @@
 # Copyright © 2019 Clark Germany GmbH
 # Author: Aljosha Friemann <[email protected]>
 
-from kinja.config import validate
+from k8t.config import validate
 
 
 def test_validate():

tests/__init__.py

@@ -1,12 +1,12 @@
 # -*- coding: utf-8 -*-
-# vim:fenc=utf-8
 #
 # Copyright © 2018 Clark Germany GmbH
+# Author: Aljosha Friemann <[email protected]>
 
 import random
 
-from kinja.util import (b64decode, b64encode, deep_merge, hashf, merge,
-                        random_password)
+from k8t.util import (b64decode, b64encode, deep_merge, hashf, merge,
+                      random_password)
 
 
 def test_merge_memory_safety():

tests/config.py

@@ -13,7 +13,7 @@ deps = pytest
        pytest-cov
 commands = py.test \
            --junit-xml=reports/junit/{envname}.xml \
-           --cov-config coverage.cfg --cov kinja --cov-report term --cov-report html:reports/coverage \
+           --cov-config coverage.cfg --cov k8t --cov-report term --cov-report html:reports/coverage \
            {posargs}
 
 [testenv:watch]