knotctl 0.1.0__tar.gz → 0.1.2__tar.gz

knotctl-0.1.2/.gitignore

@@ -0,0 +1,162 @@
+# ---> Python
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+

knotctl-0.1.2/Makefile

@@ -0,0 +1,13 @@
+.PHONY: publish
+publish:
+	 flit publish
+
+.PHONY: deb
+deb:
+	briefcase update linux system --target debian:testing
+	briefcase build linux system --target debian:testing
+	briefcase package linux system --target debian:testing
+
+.PHONY: clean
+clean:
+	rm -rf build dist

{knotctl-0.1.0 → knotctl-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: knotctl
-Version: 0.1.0
+Version: 0.1.2
 Summary: A CLI for knotapi.
 Author-email: Micke Nordin <hej@mic.ke>
 Requires-Python: >=3.9
@@ -8,10 +8,12 @@ Description-Content-Type: text/markdown
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
+License-File: LICENSE
 Requires-Dist: argcomplete==2.0.0
 Requires-Dist: pyyaml==6.0.1
 Requires-Dist: requests==2.27.1
 Requires-Dist: simplejson==3.17.6
+Requires-Dist: openstacksdk==4.2.0
 Project-URL: Documentation, https://code.smolnet.org/micke/knotctl
 Project-URL: Source, https://code.smolnet.org/micke/knotctl
 
@@ -20,11 +22,15 @@ Project-URL: Source, https://code.smolnet.org/micke/knotctl
 This is a commandline tool for knotapi: https://gitlab.nic.cz/knot/knot-dns-rest
 
 ## Build and install
+The preffered method of installation is via pipx:
+```
+pipx install knotctl
+```
 
 To install using pip, run the following command in a virtual envrionment.
 
 ```
-python -m pip install "knotctl @ git+https://code.smolnet.org/micke/knotctl
+python -m pip install knotctl
 ```
 
 To build and install as a deb-package
@@ -208,9 +214,9 @@ options:
 ### LIST
 
 ```
-usage: knotctl list [-h] [-d DATA] [-n NAME] [-r RTYPE] -z ZONE
+usage: knotctl list [-h] [-d DATA] [-n NAME] [-r RTYPE] [-z ZONE]
 
-List records in the zone.
+List records.
 
 options:
   -h, --help            show this help message and exit
@@ -249,3 +255,26 @@ Available arguments are:
     ttl: New record time to live (TTL).
 ```
 
+### USER
+```
+usage: knotctl user [-h] [-u USERNAME]
+
+View user information.
+
+options:
+  -h, --help            show this help message and exit
+  -u USERNAME, --username USERNAME
+```
+
+### ZONE
+
+```
+usage: knotctl zone 
+
+List zones.
+
+options:
+  -h, --help            show this help message and exit
+```
+
+

{knotctl-0.1.0 → knotctl-0.1.2}/README.md

@@ -3,11 +3,15 @@
 This is a commandline tool for knotapi: https://gitlab.nic.cz/knot/knot-dns-rest
 
 ## Build and install
+The preffered method of installation is via pipx:
+```
+pipx install knotctl
+```
 
 To install using pip, run the following command in a virtual envrionment.
 
 ```
-python -m pip install "knotctl @ git+https://code.smolnet.org/micke/knotctl
+python -m pip install knotctl
 ```
 
 To build and install as a deb-package
@@ -191,9 +195,9 @@ options:
 ### LIST
 
 ```
-usage: knotctl list [-h] [-d DATA] [-n NAME] [-r RTYPE] -z ZONE
+usage: knotctl list [-h] [-d DATA] [-n NAME] [-r RTYPE] [-z ZONE]
 
-List records in the zone.
+List records.
 
 options:
   -h, --help            show this help message and exit
@@ -231,3 +235,26 @@ Available arguments are:
     rtype: New record type.
     ttl: New record time to live (TTL).
 ```
+
+### USER
+```
+usage: knotctl user [-h] [-u USERNAME]
+
+View user information.
+
+options:
+  -h, --help            show this help message and exit
+  -u USERNAME, --username USERNAME
+```
+
+### ZONE
+
+```
+usage: knotctl zone 
+
+List zones.
+
+options:
+  -h, --help            show this help message and exit
+```
+

knotctl-0.1.2/publiccode.yml

@@ -0,0 +1,41 @@
+publiccodeYmlVersion: "0.4"
+
+name: knotctl
+url: "https://platform.sunet.se/SUNET/knotctl"
+platforms:
+  - linux
+  - mac
+
+categories:
+  - it-service-management
+
+developmentStatus: development
+
+softwareType: "standalone/desktop"
+
+description:
+  en:
+    shortDescription: >
+      This is a commandline tool for knotapirestapi
+      https://gitlab.nic.cz/knot/knot-dns-rest
+
+    longDescription: >
+      This is a commandline tool for knotapirestapi
+      https://gitlab.nic.cz/knot/knot-dns-rest
+
+    features:
+      - DNS management
+
+legal:
+  license: GPL-3.0
+
+maintenance:
+  type: "community"
+
+  contacts:
+    - name: Micke Nordin <kano@sunet.se>
+
+localisation:
+  localisationReady: false
+  availableLanguages:
+    - en

{knotctl-0.1.0 → knotctl-0.1.2}/pyproject.toml

@@ -16,13 +16,14 @@ classifiers=[
         "Operating System :: OS Independent",
         ]
 requires-python= ">=3.9"
-version = "0.1.0"
+version = "0.1.2"
 
 dependencies = [
   "argcomplete==2.0.0",
   "pyyaml==6.0.1",
   "requests==2.27.1",
   "simplejson==3.17.6",
+  "openstacksdk==4.2.0",
 ]
 
 [project.urls]
@@ -34,4 +35,28 @@ knotctl="knotctl:main"
 
 
 [tool.flit.sdist]
-include = ["LICENSE",]
+include = ["LICENSE", "README.md"]
+
+[tool.briefcase]
+project_name = "knotctl"
+bundle = "org.smolnet"
+version = "0.1.2"
+
+[tool.briefcase.app.knotctl]
+formal_name = "knotctl"
+description = "A CLI for knotapi."
+long_description = "A CLI for knotapi."
+sources = ['src/knotctl']
+console_app = "True"
+requires = [
+  "argcomplete==2.0.0",
+  "pyyaml==6.0.1",
+  "requests==2.27.1",
+  "simplejson==3.17.6",
+  "openstacksdk==4.2.0",
+]
+
+[tool.briefcase.app.knotctl.linux.system.debian]
+system_runtime_requires = [
+    "libpython3.13",
+]

knotctl-0.1.2/requirements.txt

@@ -0,0 +1,5 @@
+argcomplete==2.0.0
+pyyaml==6.0.1
+requests==2.27.1
+simplejson==3.17.6
+openstacksdk==4.2.0

knotctl-0.1.2/src/knotctl/__init__.py

@@ -0,0 +1,204 @@
+#!/usr/bin/env python3
+
+import getpass
+import os
+import sys
+from typing import Union
+from urllib.parse import quote
+
+import requests
+from simplejson.errors import JSONDecodeError as SimplejsonJSONDecodeError
+
+from .config import Config
+from .runners import Run
+from .utils import error, get_parser, output, setup_url
+
+try:
+    from requests.exceptions import JSONDecodeError as RequestsJSONDecodeError
+except ImportError:
+    from requests.exceptions import InvalidJSONError as RequestsJSONDecodeError
+
+
+class Knotctl:
+
+    def __init__(self):
+        self.conf = Config()
+        self.config = self.get_config()
+        self.config_filename = self.conf.config_filename
+        self.runner = Run()
+
+    def get_config(self):
+        config = self.conf.get_config()
+        if not config:
+            print("You need to configure knotctl before proceeding")
+            run_config()
+
+        return config
+
+    def run(self, url: str, args: dict, baseurl: str, parser: dict,
+            username: str):
+        try:
+            if args.command == "add":
+                self.runner.add(url, args.json)
+            elif args.command == "delete":
+                self.runner.delete(url, args.json)
+            elif args.command == "list":
+                self.runner.lister(url, args.json)
+            elif args.command == "update":
+                self.runner.update(url, args.json)
+            elif args.command == "user":
+                url = baseurl + f"/user/info/{username}"
+                self.runner.lister(url, args.json)
+            elif args.command == "auditlog":
+                url = baseurl + "/user/auditlog"
+                self.runner.log(url, args.json)
+            elif args.command == "changelog":
+                url = baseurl + f"/zones/changelog/{args.zone.rstrip('.')}"
+                self.runner.log(url, args.json)
+            elif args.command == "zone":
+                url = baseurl + "/zones"
+                self.runner.zone(url, args.json)
+            elif args.command == "openstack-sync":
+                self.runner.openstack_sync(args.cloud, args.name, args.zone,
+                                           baseurl, args.json)
+            else:
+                parser.print_help(sys.stderr)
+                return 2
+        except requests.exceptions.RequestException as e:
+            output(error(e, "Could not connect to server"))
+        except (RequestsJSONDecodeError, SimplejsonJSONDecodeError):
+            output(
+                error("Could not decode api response as JSON",
+                      "Could not decode"))
+        return 0
+
+
+def run_complete(shell: Union[None, str]):
+    if not shell or shell in ["bash", "zsh"]:
+        os.system("register-python-argcomplete knotctl")
+    elif shell == "fish":
+        os.system("register-python-argcomplete --shell fish knotctl")
+    elif shell == "tcsh":
+        os.system("register-python-argcomplete --shell tcsh knotctl")
+
+
+def run_config(
+    context: Union[None, str] = None,
+    baseurl: Union[None, str] = None,
+    list_config: bool = False,
+    username: Union[None, str] = None,
+    password: Union[None, str] = None,
+    current: Union[None, str] = None,
+):
+    conf = Config()
+    if current:
+        print(conf.get_current())
+        return
+    config = {"baseurl": baseurl, "username": username, "password": password}
+    needed = []
+    if context:
+        found = conf.set_context(context)
+        if found:
+            return
+    if list_config:
+        config_data = conf.get_config_data()
+        output(config_data)
+        return
+    if not baseurl:
+        needed.append("baseurl")
+    if not username:
+        needed.append("username")
+    for need in needed:
+        if need == "":
+            output(
+                error(
+                    "Can not configure without {}".format(need),
+                    "No {}".format(need),
+                ))
+            sys.exit(1)
+        config[need] = input("Enter {}: ".format(need))
+
+    if not password:
+        try:
+            config["password"] = getpass.getpass()
+        except EOFError:
+            output(error("Can not configure without password", "No password"))
+            sys.exit(1)
+
+    conf.set_config(config)
+
+
+# Entry point to program
+def main() -> int:
+    parser = get_parser()
+    args = parser.parse_args()
+    if args.command == "completion":
+        run_complete(args.shell)
+        return 0
+
+    knotctl = Knotctl()
+
+    if args.command == "config":
+        run_config(
+            args.context,
+            args.baseurl,
+            args.list_config,
+            args.username,
+            args.password,
+            args.current,
+        )
+        return 0
+
+    config = knotctl.get_config()
+    baseurl = config["baseurl"]
+    token = knotctl.conf.get_token()
+    if token == "":
+        print("Could not get token, exiting")
+        return 1
+
+    # Route based on command
+    url = ""
+    ttl = None
+    quotedata = None
+    user = config["username"]
+    if "ttl" in args:
+        ttl = args.ttl
+    if "data" in args:
+        quotedata = quote(args.data, safe="")
+    if args.command != "update":
+        args.argument = None
+    if args.command == "add" and not ttl:
+        if args.zone.endswith("."):
+            zname = args.zone
+        else:
+            zname = args.zone + "."
+        soa_url = setup_url(baseurl, None, None, zname, "SOA", None, args.zone)
+        soa_json = knotctl.runner.lister(soa_url, True, ret=True)
+        ttl = soa_json[0]["ttl"]
+    if args.command == "user":
+        if args.username:
+            user = args.username
+    if args.command in [
+            "auditlog", "changelog", "openstack-sync", "user", "zone"
+    ]:
+        pass
+    else:
+        try:
+            url = setup_url(
+                baseurl,
+                args.argument,
+                quotedata,
+                args.name,
+                args.rtype,
+                ttl,
+                args.zone,
+            )
+        except AttributeError:
+            parser.print_help(sys.stderr)
+            return 1
+
+    return knotctl.run(url, args, baseurl, parser, user)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

knotctl-0.1.2/src/knotctl/__main__.py

@@ -0,0 +1,4 @@
+from knotctl import main
+
+if __name__ == "__main__":
+    main()

knotctl-0.1.2/src/knotctl/config/__init__.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+import os
+from os import mkdir
+from os.path import isdir, isfile, join
+from typing import Union
+
+import requests
+import yaml
+from requests.models import HTTPBasicAuth
+
+from ..utils import error, output
+
+
+class Config:
+
+    def __init__(self):
+        # Make sure we have config
+        self.config_basepath = join(os.environ["HOME"], ".knot")
+        self.config_filename = join(self.config_basepath, "config")
+        if not isdir(self.config_basepath):
+            mkdir(self.config_basepath)
+
+    def get_config(self) -> Union[None, dict]:
+        if not isfile(self.config_filename):
+            return None
+        with open(self.config_filename, "r") as fh:
+            return yaml.safe_load(fh.read())
+
+    def get_config_data(self) -> dict:
+        config_data = self.get_config()
+        config_data.pop("password", None)
+        return config_data
+
+    def get_current(self) -> str:
+        if os.path.islink(self.config_filename):
+            actual_path = os.readlink(self.config_filename)
+            return actual_path.split("-")[-1]
+        else:
+            return "none"
+
+    def get_token(self) -> str:
+        # Authenticate
+        config = self.get_config()
+        baseurl = config["baseurl"]
+        username = config["username"]
+        password = config["password"]
+        basic = HTTPBasicAuth(username, password)
+        response = requests.get(baseurl + "/user/login", auth=basic)
+        token = ""
+        try:
+            token = response.json()["token"]
+        except KeyError:
+            output(response.json())
+        except requests.exceptions.JSONDecodeError:
+            output(
+                error("Could not decode api response as JSON",
+                      "Could not decode"))
+        return token
+
+    def set_context(self, context) -> bool:
+        symlink = f"{self.config_filename}-{context}"
+        found = os.path.isfile(symlink)
+        if os.path.islink(self.config_filename):
+            os.remove(self.config_filename)
+        elif os.path.isfile(self.config_filename):
+            os.rename(self.config_filename, symlink)
+        os.symlink(symlink, self.config_filename)
+        self.config_filename = symlink
+        return found
+
+    def set_config(
+        self,
+        baseurl: str,
+        username: str,
+        password: str,
+    ):
+        config = {
+            "baseurl": baseurl,
+            "username": username,
+            "password": password
+        }
+
+        with open(self.config_filename, "w") as fh:
+            fh.write(yaml.dump(config))