separate cli and gui application in own python packages. provide database schema as python package.

python/kontor-cli.backup/.gitignore

@@ -0,0 +1,105 @@
+# 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/
+*.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/
+.coverage
+.coverage.*
+coverage-report/
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# 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/

python/kontor-cli.backup/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Kontor CLI Change History
+
+## 0.0.1
+
+Initial release.

python/kontor-cli.backup/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.9-alpine
+LABEL MAINTAINER="Thomas Peetz <thomas.peetz@thpeetz.de>"
+ENV PS1="\[\e[0;33m\]|> kontor <| \[\e[1;35m\]\W\[\e[0m\] \[\e[0m\]# "
+
+WORKDIR /src
+COPY . /src
+RUN pip install --no-cache-dir -r requirements.txt \
+    && python setup.py install
+WORKDIR /
+ENTRYPOINT ["kontor"]

python/kontor-cli.backup/LICENSE.md

@@ -0,0 +1 @@
+

python/kontor-cli.backup/MANIFEST.in

@@ -0,0 +1,5 @@
+recursive-include *.py
+include setup.cfg
+include README.md CHANGELOG.md LICENSE.md
+include *.txt
+recursive-include kontor/templates *

python/kontor-cli.backup/Makefile

@@ -0,0 +1,31 @@
+.PHONY: clean virtualenv test docker dist dist-upload
+
+clean:
+	find . -name '*.py[co]' -delete
+
+virtualenv:
+	virtualenv --prompt '|> kontor <| ' env
+	env/bin/pip install -r requirements-dev.txt
+	env/bin/python setup.py develop
+	@echo
+	@echo "VirtualENV Setup Complete. Now run: source env/bin/activate"
+	@echo
+
+test:
+	python -m pytest \
+		-v \
+		--cov=kontor \
+		--cov-report=term \
+		--cov-report=html:coverage-report \
+		tests/
+
+docker: clean
+	docker build -t kontor:latest .
+
+dist: clean
+	rm -rf dist/*
+	python setup.py sdist
+	python setup.py bdist_wheel
+
+dist-upload:
+	twine upload dist/*

python/kontor-cli.backup/README.md

@@ -0,0 +1,69 @@
+# Kontor CLI
+
+## Installation
+
+```
+$ pip install -r requirements.txt
+
+$ python setup.py install
+```
+
+## Development
+
+This project includes a number of helpers in the `Makefile` to streamline common development tasks.
+
+### Environment Setup
+
+The following demonstrates setting up and working with a development environment:
+
+```
+### create a virtualenv for development
+
+$ make virtualenv
+
+$ source env/bin/activate
+
+
+### run kontor cli application
+
+$ kontor --help
+
+
+### run pytest / coverage
+
+$ make test
+```
+
+
+### Releasing to PyPi
+
+Before releasing to PyPi, you must configure your login credentials:
+
+**~/.pypirc**:
+
+```
+[pypi]
+username = YOUR_USERNAME
+password = YOUR_PASSWORD
+```
+
+Then use the included helper function via the `Makefile`:
+
+```
+$ make dist
+
+$ make dist-upload
+```
+
+## Deployments
+
+### Docker
+
+Included is a basic `Dockerfile` for building and distributing `Kontor CLI`,
+and can be built with the included `make` helper:
+
+```
+$ make docker
+
+$ docker run -it kontor --help
+```

python/kontor-cli.backup/config/kontor.yml.example

@@ -0,0 +1,46 @@
+### Kontor CLI Configuration Settings
+---
+
+kontor:
+
+### Toggle application level debug (does not toggle framework debugging)
+# debug: false
+
+### Where external (third-party) plugins are loaded from
+# plugin_dir: /var/lib/kontor/plugins/
+
+### Where all plugin configurations are loaded from
+# plugin_config_dir: /etc/kontor/plugins.d/
+
+### Where external templates are loaded from
+# template_dir: /var/lib/kontor/templates/
+
+### The log handler label
+# log_handler: colorlog
+
+### The output handler label
+# output_handler: jinja2
+
+### sample foo option
+# foo: bar
+
+
+log.colorlog:
+
+### Where the log file lives (no log file by default)
+# file: null
+
+### The level for which to log.  One of: info, warning, error, fatal, debug
+# level: info
+
+### Whether or not to log to console
+# to_console: true
+
+### Whether or not to rotate the log file when it reaches `max_bytes`
+# rotate: false
+
+### Max size in bytes that a log file can grow until it is rotated.
+# max_bytes: 512000
+
+### The maximum number of log files to maintain when rotating
+# max_files: 4

python/kontor-cli.backup/kontor/controllers/base.py

@@ -0,0 +1,35 @@
+
+from cement import Controller, ex
+from cement.utils.version import get_version_banner
+from ..core.version import get_version
+
+VERSION_BANNER = """
+Kontor CLI %s
+%s
+""" % (get_version(), get_version_banner())
+
+
+class Base(Controller):
+    class Meta:
+        label = 'base'
+
+        # text displayed at the top of --help output
+        description = 'Kontor CLI Tool'
+
+        # text displayed at the bottom of --help output
+        epilog = 'Usage: kontor (database | media) [subcommands]'
+
+        # controller level arguments. ex: 'kontor --version'
+        arguments = [
+            ### add a version banner
+            (['-v', '--version'],
+             {'action': 'version',
+              'version': VERSION_BANNER}),
+            (['-m', '--dry-run'],
+             {'action': 'store_true',
+              'dest': 'dry_run'})
+        ]
+
+    def _default(self):
+        """Default action if no sub-command is passed."""
+        self.app.args.print_help()

python/kontor-cli.backup/kontor/controllers/database.py

@@ -0,0 +1,51 @@
+from cement import Controller, ex
+from kontor_schema import KontorDB
+
+
+class Database(Controller):
+
+    class Meta:
+        label = 'database'
+        stacked_type = 'nested'
+        stacked_on = 'base'
+
+    @ex(
+        help='export database to given file',
+        arguments=[
+            (['-f', '--file'],
+             {'help': 'file to store database content',
+              'action': 'store',
+              'dest': 'db_file'})
+        ],
+    )
+    def export(self):
+        data = {
+            'db_file': 'data.json',
+            'export_type': 'JSON',
+        }
+        if self.app.pargs.db_file is not None:
+            data['db_file'] = self.app.pargs.db_file
+        kontor_db = KontorDB(self.app.engine, self.app.config, self.app.log)
+        kontor_db.export_db(data['export_type'], data['db_file'])
+        self.app.render(data, 'command1.jinja2')
+
+    @ex(
+        label='import',
+        help='import data from file into database',
+        arguments=[
+            (['-f', '--file'],
+             {'help': 'file to read data',
+              'action': 'store',
+              'dest': 'db_file'})
+        ],
+    )
+    def import_cmd(self):
+        data = {
+            'db_file': 'data.json',
+            'data_type': 'JSON',
+        }
+        if self.app.pargs.db_file is not None:
+            data['db_file'] = self.app.pargs.db_file
+        kontor_db = KontorDB(self.app.engine, self.app.config, self.app.log)
+        self.app.render(data, 'import.jinja2')
+        kontor_db.import_db(data['db_file'], self.app.pargs.dry_run)

python/kontor-cli.backup/kontor/controllers/media.py

@@ -0,0 +1,79 @@
+from cement import Controller, ex
+
+from ..database import KontorDB
+
+
+class Media(Controller):
+
+    class Meta:
+        label = 'media'
+        stacked_type = 'nested'
+        stacked_on = 'base'
+
+    @ex(
+        label='update',
+        help='update title for mediafiles',
+    )
+    def update_title(self):
+        kontor_db = KontorDB(self.app.engine, self.app.config, self.app.log)
+        kontor_db.update_title(self.app.pargs.dry_run)
+
+    @ex(
+        label='download',
+        help='download all marked videos',
+        arguments=[
+            (['-d', '--dir'],
+             {'help': 'directory to store videos',
+              'action': 'store',
+              'dest': 'media_dir'})
+        ],
+    )
+    def download(self):
+        data = {
+            'media_dir': '/data/media',
+        }
+        if self.app.pargs.media_dir is not None:
+            data['media_dir'] = self.app.pargs.media_dir
+        kontor_db = KontorDB(self.app.engine, self.app.config, self.app.log)
+        kontor_db.download_file(self.app.pargs.dry_run)
+
+    @ex(
+        help='add url to database',
+        arguments=[
+            (['-u', '--url'],
+             {'help': 'link to downloadable video',
+              'action': 'store',
+              'dest': 'link'})
+        ],
+    )
+    def add(self):
+        data = {
+            'link_url': None
+        }
+        if self.app.pargs.link is not None:
+            data['link_url'] = self.app.pargs.link
+            if self.app.pargs.dry_run:
+                print(f"add url {data['link_url']} to database")
+            kontor_db = KontorDB(self.app.engine, self.app.config, self.app.log)
+            kontor_db.add_link(self.app.pargs.link, self.app.pargs.dry_run)
+
+        else:
+            print("no url was given.")
+
+    @ex(
+        help='check files if existing',
+        arguments=[
+            (['-d', '--dir'],
+             {'help': 'directory to store videos',
+              'action': 'store',
+              'dest': 'media_dir'})
+        ],
+    )
+    def check(self):
+        data = {
+            'media_dir': '/data/media',
+        }
+        if self.app.pargs.media_dir is not None:
+            data['media_dir'] = self.app.pargs.media_dir
+        kontor_db = KontorDB(self.app.engine, self.app.config, self.app.log)
+        kontor_db.check_files()

python/kontor-cli.backup/kontor/core/exc.py

@@ -0,0 +1,4 @@
+
+class KontorCliError(Exception):
+    """Generic errors."""
+    pass

python/kontor-cli.backup/kontor/core/version.py

@@ -0,0 +1,7 @@
+
+from cement.utils.version import get_version as cement_get_version
+
+VERSION = (0, 1, 0, 'alpha', 0)
+
+def get_version(version=VERSION):
+    return cement_get_version(version)

python/kontor-cli.backup/kontor/main.py

@@ -0,0 +1,124 @@
+
+from cement import App, TestApp, init_defaults
+from cement.core.exc import CaughtSignal
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+
+from .controllers.database import Database
+from .controllers.media import Media
+from .core.exc import KontorCliError
+from .controllers.base import Base
+
+# configuration defaults
+CONFIG = init_defaults('kontor', 'mariadb', 'media')
+CONFIG['kontor']['foo'] = 'bar'
+CONFIG['mariadb']['user'] = 'kontor'
+CONFIG['mariadb']['password'] = 'kontor'
+CONFIG['mariadb']['host'] = '127.0.0.1'
+CONFIG['mariadb']['port'] = '3306'
+CONFIG['mariadb']['database'] = 'kontor'
+CONFIG['media']['yt-dlp'] = '/home/tpeetz/bin/yt-dlp'
+CONFIG['media']['dir'] = '/data/media'
+META =  init_defaults('output.json', 'output.yaml')
+META['output.json']['overridable'] = True
+META['output.yaml']['overridable'] = True
+
+
+def extend_sqlalchemy(app):
+    app.log.info('extending kontor application with sqlalchemy')
+    connect_string = ('mariadb+mariadbconnector://{}:{}@{}:{}/{}'.format(
+        app.config.get('mariadb', 'user'),
+        app.config.get('mariadb', 'password'),
+        app.config.get('mariadb', 'host'),
+        app.config.get('mariadb', 'port'),
+        app.config.get('mariadb', 'database')
+    ))
+    # engine = create_engine(connect_string, echo=True)
+    engine = create_engine(connect_string)
+    Base.metadata.create_all(bind=engine)
+    __session__ = sessionmaker(bind=engine)
+    app.extend('engine', engine)
+
+
+class KontorCli(App):
+    """Kontor CLI primary application."""
+
+    class Meta:
+        label = 'kontor'
+
+        # configuration defaults
+        config_defaults = CONFIG
+
+        meta_defaults = META
+
+        # call sys.exit() on close
+        exit_on_close = True
+
+        # load additional framework extensions
+        extensions = [
+            'yaml',
+            'json',
+            'colorlog',
+            'jinja2',
+        ]
+
+        # configuration handler
+        config_handler = 'yaml'
+
+        # configuration file suffix
+        config_file_suffix = '.yml'
+
+        # set the log handler
+        log_handler = 'colorlog'
+
+        # set the output handler
+        output_handler = 'jinja2'
+
+        hooks = [
+            ('post_setup', extend_sqlalchemy),
+        ]
+
+        # register handlers
+        handlers = [
+            Base,
+            Database,
+            Media,
+        ]
+
+
+class KontorCliTest(TestApp,KontorCli):
+    """A sub-class of KontorCli that is better suited for testing."""
+
+    class Meta:
+        label = 'kontor'
+
+
+def main():
+    with KontorCli() as app:
+        try:
+            app.run()
+
+        except AssertionError as e:
+            print('AssertionError > %s' % e.args[0])
+            app.exit_code = 1
+
+            if app.debug is True:
+                import traceback
+                traceback.print_exc()
+
+        except KontorCliError as e:
+            print('KontorCliError > %s' % e.args[0])
+            app.exit_code = 1
+
+            if app.debug is True:
+                import traceback
+                traceback.print_exc()
+
+        except CaughtSignal as e:
+            # Default Cement signals are SIGINT and SIGTERM, exit 0 (non-error)
+            print('\n%s' % e)
+            app.exit_code = 0
+
+
+if __name__ == '__main__':
+    main()

python/kontor-cli.backup/kontor/templates/command1.jinja2

@@ -0,0 +1,4 @@
+
+Example Template (templates/command1.jinja2)
+
+Foo => {{ foo }}

python/kontor-cli.backup/kontor/templates/download.jinja2

@@ -0,0 +1,2 @@
+
+Download videos to directory {{ media_dir }}

python/kontor-cli.backup/kontor/templates/import.jinja2

@@ -0,0 +1,2 @@
+
+Import data from {{ db_file }}

python/kontor-cli.backup/kontor/templates/update.jinja2

@@ -0,0 +1,2 @@
+
+Update entries of mediafile

python/kontor-cli.backup/requirements-dev.txt

@@ -0,0 +1,8 @@
+-r requirements.txt
+
+pytest
+pytest-cov
+coverage
+twine>=1.11.0
+setuptools>=38.6.0
+wheel>=0.31.0

python/kontor-cli.backup/requirements.txt

@@ -0,0 +1,6 @@
+cement==3.0.12
+cement[jinja2]
+cement[yaml]
+cement[colorlog]
+mariadb
+sqlalchemy

python/kontor-cli.backup/setup.py

@@ -0,0 +1,28 @@
+
+from setuptools import setup, find_packages
+from kontor.core.version import get_version
+
+VERSION = get_version()
+
+f = open('README.md', 'r')
+LONG_DESCRIPTION = f.read()
+f.close()
+
+setup(
+    name='kontor',
+    version=VERSION,
+    description='Kontor CLI',
+    long_description=LONG_DESCRIPTION,
+    long_description_content_type='text/markdown',
+    author='Thomas Peetz',
+    author_email='thomas.peetz@thpeetz.de',
+    url='https://gitlab.com/tpeetz/kontor/',
+    license='MIT',
+    packages=find_packages(exclude=['ez_setup', 'tests*']),
+    package_data={'kontor': ['templates/*']},
+    include_package_data=True,
+    entry_points="""
+        [console_scripts]
+        kontor = kontor.main:main
+    """,
+)

python/kontor-cli.backup/tests/conftest.py

@@ -0,0 +1,16 @@
+"""
+PyTest Fixtures.
+"""
+
+import pytest
+from cement import fs
+
+@pytest.fixture(scope="function")
+def tmp(request):
+    """
+    Create a `tmp` object that geneates a unique temporary directory, and file
+    for each test function that requires it.
+    """
+    t = fs.Tmp()
+    yield t
+    t.remove()

python/kontor-cli.backup/tests/test_kontor.py

@@ -0,0 +1,36 @@
+
+from pytest import raises
+from kontor.main import KontorCliTest
+
+def test_kontor():
+    # test kontor without any subcommands or arguments
+    with KontorCliTest() as app:
+        app.run()
+        assert app.exit_code == 0
+
+
+def test_kontor_debug():
+    # test that debug mode is functional
+    argv = ['--debug']
+    with KontorCliTest(argv=argv) as app:
+        app.run()
+        assert app.debug is True
+
+
+def test_command1():
+    # test command1 without arguments
+    argv = ['command1']
+    with KontorCliTest(argv=argv) as app:
+        app.run()
+        data,output = app.last_rendered
+        assert data['foo'] == 'bar'
+        assert output.find('Foo => bar')
+
+
+    # test command1 with arguments
+    argv = ['command1', '--foo', 'not-bar']
+    with KontorCliTest(argv=argv) as app:
+        app.run()
+        data,output = app.last_rendered
+        assert data['foo'] == 'not-bar'
+        assert output.find('Foo => not-bar')