plugins/ci migration from v3 to v4

.circleci/config.yml

@@ -1,158 +0,0 @@
----
-version: 2.1
-
-orbs:
-  python: circleci/python@2.1.1
-
-executors:
-  python:
-    docker:
-      - image: cimg/python:3.11
-    resource_class: small
-
-  nodejs:
-    docker:
-      - image: node:18
-    resource_class: medium
-
-
-jobs:
-  python-test:
-    executor: python
-    working_directory: ~/scwrypts/py/lib
-    steps:
-      - checkout:
-          path: ~/scwrypts
-      - run:
-          name: pytest
-          command: |
-            : \
-              && pip install . .[test] \
-              && pytest \
-              ;
-      - run: pip install build && python -m build
-
-  python-publish:
-    executor: python
-    working_directory: ~/scwrypts/py/lib
-    steps:
-      - checkout:
-          path: ~/scwrypts
-      - run: pip install build && python -m build
-      - run: pip install twine && twine upload dist/*
-
-  nodejs-test:
-    executor: nodejs
-    working_directory: ~/scwrypts/zx/lib
-    steps:
-      - checkout:
-          path: ~/scwrypts
-
-      - restore_cache:
-          name: restore pnpm cache
-          keys:
-            - pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
-
-      - run:
-          name: pnpm install
-          command: |
-            corepack enable
-            corepack prepare pnpm@latest-8 --activate
-            pnpm config set store-dir .pnpm-store
-            pnpm install
-
-      - save_cache:
-          name: save pnpm cache
-          key: pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
-          paths:
-            - .pnpm-store
-
-      - run: pnpm test
-      - run: pnpm lint
-      - run: pnpm build
-
-  nodejs-publish:
-    executor: nodejs
-    working_directory: ~/scwrypts/zx/lib
-    steps:
-      - checkout:
-          path: ~/scwrypts
-
-      - restore_cache:
-          name: restore pnpm cache
-          keys:
-            - pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
-
-      - run:
-          name: pnpm install
-          command: |
-            corepack enable
-            corepack prepare pnpm@latest-8 --activate
-            pnpm config set store-dir .pnpm-store
-            pnpm install
-
-      - save_cache:
-          name: save pnpm cache
-          key: pnpm-packages-{{ checksum "pnpm-lock.yaml" }}
-          paths:
-            - .pnpm-store
-
-      - run:
-          name: publish
-          command: |
-            : \
-              && [ $CIRCLE_TAG ] \
-              && pnpm build \
-              && pnpm version $CIRCLE_TAG \
-              && pnpm set //registry.npmjs.org/:_authToken=$NPM_TOKEN \
-              && pnpm publish --no-git-checks \
-              ;
-
-workflows:
-  python-dev:
-    jobs:
-      - python-test:
-          filters:
-            branches:
-              ignore: /^main$/
-
-  python:
-    jobs:
-      - python-test:
-          filters:
-            tags:
-              only: /^v\d+\.\d+\.\d+.*$/
-            branches:
-              ignore: /^.*$/
-      - python-publish:
-          requires: [python-test]
-          context: [pypi-yage]
-          filters:
-            tags:
-              only: /^v\d+\.\d+\.\d+.*$/
-            branches:
-              ignore: /^.*$/
-
-  nodejs-dev:
-    jobs:
-      - nodejs-test:
-          filters:
-            branches:
-              ignore: /^main$/
-
-  nodejs:
-    jobs:
-      - nodejs-test:
-          filters:
-            tags:
-              only: /^v\d+\.\d+\.\d+.*$/
-            branches:
-              ignore: /^.*$/
-      - nodejs-publish:
-          requires: [nodejs-test]
-          context: [npm-wrynegade]
-          filters:
-            tags:
-              only: /^v\d+\.\d+\.\d+.*$/
-            branches:
-              ignore: /^.*$/

action.yaml

@@ -29,7 +29,6 @@ runs:
         repository: wrynegade/scwrypts
         path: ./wrynegade/scwrypts
         ref: ${{ inputs.version }}
-        fetch-tags: true
 
     - name: check dependencies
       shell: bash
@@ -52,7 +51,7 @@ runs:
         } > $HOME/.scwrypts.apt-get.log 2>&1
 
         echo "updating virtual dependencies"
-        $GITHUB_WORKSPACE/wrynegade/scwrypts/scwrypts \
+        $GITHUB_WORKSPACE/wrynegade/scwrypts/scwrypts -n \
           --name scwrypts/virtualenv/update-all \
           --group scwrypts \
           --type zsh \

py/data/convert/csv-to-json.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python
-from scwrypts import execute
+from py.lib.data.converter import convert
+from py.lib.scwrypts import execute
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
 #####################################################################
-from scwrypts.data import convert
-
-
-description = 'convert csv into json'
-parse_args = []
 
 def main(_args, stream):
     return convert(
@@ -16,5 +18,7 @@ def main(_args, stream):
             )
 
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'convert csv into json',
+        parse_args = [],
+        )

py/data/convert/csv-to-yaml.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python
-from scwrypts import execute
+from py.lib.data.converter import convert
+from py.lib.scwrypts import execute
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
 #####################################################################
-from scwrypts.data import convert
-
-
-description = 'convert csv into yaml'
-parse_args = []
 
 def main(_args, stream):
     return convert(
@@ -16,5 +18,7 @@ def main(_args, stream):
             )
 
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'convert csv into yaml',
+        parse_args = [],
+        )

py/data/convert/json-to-csv.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python
-from scwrypts import execute
+from py.lib.data.converter import convert
+from py.lib.scwrypts import execute
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
 #####################################################################
-from scwrypts.data import convert
-
-
-description = 'convert json into csv'
-parse_args = []
 
 def main(_args, stream):
     return convert(
@@ -16,5 +18,7 @@ def main(_args, stream):
             )
 
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'convert json into csv',
+        parse_args = [],
+        )

py/data/convert/json-to-yaml.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python
-from scwrypts import execute
+from py.lib.data.converter import convert
+from py.lib.scwrypts import execute
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
 #####################################################################
-from scwrypts.data import convert
-
-
-description = 'convert json into yaml'
-parse_args = []
 
 def main(_args, stream):
     return convert(
@@ -16,5 +18,7 @@ def main(_args, stream):
             )
 
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'convert json into yaml',
+        parse_args = [],
+        )

py/data/convert/yaml-to-csv.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python
-from scwrypts import execute
+from py.lib.data.converter import convert
+from py.lib.scwrypts import execute
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
 #####################################################################
-from scwrypts.data import convert
-
-
-description = 'convert yaml into csv'
-parse_args = []
 
 def main(_args, stream):
     return convert(
@@ -16,5 +18,7 @@ def main(_args, stream):
             )
 
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'convert yaml into csv',
+        parse_args = [],
+        )

py/data/convert/yaml-to-json.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python
-from scwrypts import execute
+from py.lib.data.converter import convert
+from py.lib.scwrypts import execute
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
 #####################################################################
-from scwrypts.data import convert
-
-
-description = 'convert yaml into json'
-parse_args = []
 
 def main(_args, stream):
     return convert(
@@ -16,5 +18,7 @@ def main(_args, stream):
             )
 
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'convert yaml into json',
+        parse_args = [],
+        )

py/directus/get-items.py

@@ -1,55 +1,16 @@
 #!/usr/bin/env python
-from scwrypts import execute
-#####################################################################
 from json import dumps
 
-from scwrypts.fzf import fzf, fzf_tail
-from scwrypts.http import directus
+from py.lib.fzf import fzf, fzf_tail
+from py.lib.http import directus
+from py.lib.scwrypts import execute
 
+from py.lib.scwrypts.exceptions import ImportedExecutableError
 
-description = 'interactive CLI to get data from directus'
+if __name__ != '__main__':
+    raise ImportedExecutableError()
 
-parse_args = [
-        ( ['-c', '--collection'], {
-            "dest"     : 'collection',
-            "default"  : None,
-            "help"     : 'the name of the collection',
-            "required" : False,
-            }),
-        ( ['-f', '--filters'], {
-            "dest"     : 'filters',
-            "default"  : None,
-            "help"     : 'as a URL-suffix, filters for the query',
-            "required" : False,
-            }),
-        ( ['-d', '--fields'], {
-            "dest"     : 'fields',
-            "default"  : None,
-            "help"     : 'comma-separated list of fields to include',
-            "required" : False,
-            }),
-        ( ['-p', '--interactive-prompt'], {
-            "action"   : 'store_true',
-            "dest"     : 'interactive',
-            "default"  : False,
-            "help"     : 'interactively generate filter prompts; implied if no flags are provided',
-            "required" : False,
-            }),
-        ( ['--prompt-filters'], {
-            "action"   : 'store_true',
-            "dest"     : 'generate_filters_prompt',
-            "default"  : False,
-            "help"     : '(superceded by -p) only generate filters interactively',
-            "required" : False,
-            }),
-        ( ['--prompt-fields'], {
-            "action"   : 'store_true',
-            "dest"     : 'generate_fields_prompt',
-            "default"  : False,
-            "help"     : '(superceded by -p) only generate filters interactively',
-            "required" : False,
-            }),
-        ]
+#####################################################################
 
 def main(args, stream):
     if {None} == { args.collection, args.filters, args.fields }:
@@ -135,6 +96,50 @@ def _get_or_select_fields(args, collection):
 
     return fields
 
+
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'interactive CLI to get data from directus',
+        parse_args = [
+            ( ['-c', '--collection'], {
+                "dest"     : 'collection',
+                "default"  : None,
+                "help"     : 'the name of the collection',
+                "required" : False,
+                }),
+            ( ['-f', '--filters'], {
+                "dest"     : 'filters',
+                "default"  : None,
+                "help"     : 'as a URL-suffix, filters for the query',
+                "required" : False,
+                }),
+            ( ['-d', '--fields'], {
+                "dest"     : 'fields',
+                "default"  : None,
+                "help"     : 'comma-separated list of fields to include',
+                "required" : False,
+                }),
+            ( ['-p', '--interactive-prompt'], {
+                "action"   : 'store_true',
+                "dest"     : 'interactive',
+                "default"  : False,
+                "help"     : 'interactively generate filter prompts; implied if no flags are provided',
+                "required" : False,
+                }),
+            ( ['--prompt-filters'], {
+                "action"   : 'store_true',
+                "dest"     : 'generate_filters_prompt',
+                "default"  : False,
+                "help"     : '(superceded by -p) only generate filters interactively',
+                "required" : False,
+                }),
+            ( ['--prompt-fields'], {
+                "action"   : 'store_true',
+                "dest"     : 'generate_fields_prompt',
+                "default"  : False,
+                "help"     : '(superceded by -p) only generate filters interactively',
+                "required" : False,
+                }),
+            ]
+
+        )

py/discord/post-message.py

@@ -1,13 +1,36 @@
 #!/usr/bin/env python
-from scwrypts import execute
-#####################################################################
 from json import dumps
 from sys import stderr
 
-from scwrypts.http import discord
+from py.lib.http import discord
+from py.lib.scwrypts import execute
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
+#####################################################################
+
+def main(args, stream):
+    if args.content is None:
+        print(f'reading input from {stream.input.name}', file=stderr)
+        args.content = ''.join(stream.readlines()).strip()
+
+    if len(args.content) == 0:
+        args.content = 'PING'
+
+    response = discord.send_message(**vars(args))
+
+    stream.writeline(dumps({
+        **(response.json() if response.text != '' else {'message': 'OK'}),
+        'scwrypts_metadata': {},
+        }))
 
 
-description = 'post a message to the indicated discord channel'
+#####################################################################
+execute(main,
+        description = 'post a message to the indicated discord channel',
         parse_args = [
             ( ['-b', '--body'], {
                 'dest'     : 'content',
@@ -35,23 +58,4 @@ parse_args = [
                 'required' : False,
                 }),
             ]
-
-def main(args, stream):
-    if args.content is None:
-        print(f'reading input from {stream.input.name}', file=stderr)
-        args.content = ''.join(stream.readlines()).strip()
-
-    if len(args.content) == 0:
-        args.content = 'PING'
-
-    response = discord.send_message(**vars(args))
-
-    stream.writeline(dumps({
-        **(response.json() if response.text != '' else {'message': 'OK'}),
-        'scwrypts_metadata': {},
-        }))
-
-
-#####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+        )

py/hello-world.py

@@ -1,8 +1,21 @@
 #!/usr/bin/env python
-from scwrypts import execute
+from py.lib.scwrypts import execute
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
 #####################################################################
 
-description = 'a simple "Hello, World!" program'
+
+def main(args, stream):
+    stream.writeline(args.message)
+
+
+#####################################################################
+execute(main,
+        description = 'a simple "Hello, World!" program',
         parse_args = [
             ( ['-m', '--message'], {
                 'dest'     : 'message',
@@ -10,12 +23,5 @@ parse_args = [
                 'help'     : 'message to print',
                 'required' : False,
                 }),
-        ]
-
-def main(args, stream):
-    stream.writeline(args.message)
-
-
-#####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+            ],
+        )

py/lib/.gitignore

@@ -1,4 +0,0 @@
-dist/
-__pycache__/
-*.py[cod]
-*.so

py/lib/README.md

@@ -1,3 +0,0 @@
-# Python Scwrypts
-[![Generic Badge](https://img.shields.io/badge/python->=3.9-informational.svg)](https://python.org)
-<br>

py/lib/__init__.py

@@ -0,0 +1,6 @@
+import py.lib.data
+import py.lib.fzf
+import py.lib.http
+import py.lib.redis
+import py.lib.scwrypts
+import py.lib.twilio

py/lib/data/__init__.py

@@ -0,0 +1 @@
+import py.lib.data.converter

py/lib/data/converter.py

@@ -4,6 +4,9 @@ import yaml
 
 
 def convert(input_stream, input_type, output_stream, output_type):
+    if input_type == output_type:
+        raise ValueError('input type and output type are the same')
+
     data = convert_input(input_stream, input_type)
     write_output(output_stream, output_type, data)
 

py/lib/fzf/__init__.py

@@ -0,0 +1 @@
+from py.lib.fzf.client import fzf, fzf_tail, fzf_head

py/lib/http/__init__.py

@@ -0,0 +1,5 @@
+from py.lib.http.client import get_request_client
+
+import py.lib.http.directus
+import py.lib.http.discord
+import py.lib.http.linear

py/lib/http/client.py

@@ -0,0 +1,20 @@
+from requests import request
+
+
+def get_request_client(base_url, headers=None):
+    if headers is None:
+        headers = {}
+
+    return lambda method, endpoint, **kwargs: request(
+            method = method,
+            url = f'{base_url}/{endpoint}',
+            headers = {
+                **headers,
+                **kwargs.get('headers', {}),
+                },
+            **{
+                key: value
+                for key, value in kwargs.items()
+                if key != 'headers'
+                },
+            )

py/lib/http/directus/__init__.py

@@ -0,0 +1,2 @@
+from py.lib.http.directus.client import *
+from py.lib.http.directus.constant import *

py/lib/http/directus/client.py

@@ -0,0 +1,56 @@
+from py.lib.http import get_request_client
+from py.lib.scwrypts import getenv
+
+
+REQUEST     = None
+COLLECTIONS = None
+FIELDS      = {}
+
+
+def request(method, endpoint, **kwargs):
+    global REQUEST # pylint: disable=global-statement
+
+    if REQUEST is None:
+        REQUEST = get_request_client(
+                base_url = getenv("DIRECTUS__BASE_URL"),
+                headers = {
+                    'Authorization': f'bearer {getenv("DIRECTUS__API_TOKEN")}',
+                    }
+                )
+
+    return REQUEST(method, endpoint, **kwargs)
+
+def graphql(query, system=False):
+    return request(
+            'POST',
+            'graphql' if system is True else 'graphql/system',
+            json={'query': query},
+            )
+
+
+def get_collections():
+    global COLLECTIONS # pylint: disable=global-statement
+
+    if COLLECTIONS is None:
+        COLLECTIONS = [
+            item['collection']
+            for item in request(
+                'GET',
+                'collections?limit=-1&fields[]=collection',
+                ).json()['data']
+            ]
+
+    return COLLECTIONS
+
+
+def get_fields(collection):
+    if FIELDS.get(collection) is None:
+        FIELDS[collection] = [
+                item['field']
+                for item in request(
+                    'GET',
+                    f'fields/{collection}?limit=-1&fields[]=field',
+                    ).json()['data']
+                ]
+
+    return FIELDS[collection]

py/lib/http/directus/constant.py

@@ -1,23 +1,3 @@
-'''
-basic scwrypts.http client for directus
-
-configured by setting DIRECTUS__BASE_URL and DIRECTUS__API_TOKEN in
-scwrypts environment
-'''
-
-__all__ = [
-        'request',
-        'graphql',
-        'get_collections',
-        'get_fields',
-        'FILTER_OPERATORS',
-        ]
-
-from .client import request
-from .graphql import graphql
-from .collections import get_collections
-from .fields import get_fields
-
 FILTER_OPERATORS = {
         '_eq',
         '_neq',

py/lib/http/discord/__init__.py

@@ -0,0 +1,2 @@
+from py.lib.http.discord.client import *
+from py.lib.http.discord.send_message import *

py/lib/http/discord/client.py

@@ -0,0 +1,20 @@
+from py.lib.http import get_request_client
+from py.lib.scwrypts import getenv
+
+REQUEST = None
+
+def request(method, endpoint, **kwargs):
+    global REQUEST # pylint: disable=global-statement
+
+    if REQUEST is None:
+        headers = {}
+
+        if (token := getenv("DISCORD__BOT_TOKEN", required = False)) is not None:
+            headers['Authorization'] = f'Bot {token}'
+
+        REQUEST = get_request_client(
+                base_url = 'https://discord.com/api',
+                headers = headers,
+                )
+
+    return REQUEST(method, endpoint, **kwargs)

py/lib/http/discord/send_message.py

@@ -1,5 +1,5 @@
-from scwrypts.env import getenv
-from .client import request
+from py.lib.scwrypts import getenv
+from py.lib.http.discord import request
 
 def send_message(content, channel_id=None, webhook=None, username=None, avatar_url=None, **kwargs):
     if username is None:

py/lib/http/linear/__init__.py

@@ -0,0 +1 @@
+from py.lib.http.linear.client import *

py/lib/http/linear/client.py

@@ -0,0 +1,20 @@
+from py.lib.http import get_request_client
+from py.lib.scwrypts import getenv
+
+REQUEST = None
+
+def request(method, endpoint, **kwargs):
+    global REQUEST # pylint: disable=global-statement
+
+    if REQUEST is None:
+        REQUEST = get_request_client(
+                base_url = 'https://api.linear.app',
+                headers = {
+                    'Authorization': f'bearer {getenv("LINEAR__API_TOKEN")}',
+                    }
+                )
+
+    return REQUEST(method, endpoint, **kwargs)
+
+def graphql(query):
+    return request('POST', 'graphql', json={'query': query})

py/lib/pyproject.toml

@@ -1,59 +0,0 @@
-[project]
-name = 'scwrypts'
-description = 'scwrypts library and invoker'
-license = 'GPL-3.0-or-later'
-
-readme = 'README.md'
-requires-python = '>=3.10'
-
-authors = [
-	{ name='yage', email='yage@yage.io' },
-]
-
-
-classifiers = [
-	'Programming Language :: Python :: 3',
-	'Programming Language :: Python :: 3.10',
-	'Programming Language :: Python :: 3.11',
-	'Programming Language :: Python :: 3.12',
-	'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
-	]
-
-dynamic = ['version']
-
-dependencies = [
-	'bpython',
-	'pyfzf',
-	'pyyaml',
-	'redis',
-	'twilio',
-]
-
-[project.optional-dependencies]
-dev = [
-	'pylint',
-]
-
-test = [
-	'pytest',
-]
-
-[project.urls]
-homepage = 'https://github.com/wrynegade/scwrypts'
-issues = 'https://github.com/wrynegade/scwrypts/issues'
-
-[build-system]
-requires = [
-	'hatchling',
-	'versioningit',
-]
-build-backend = 'hatchling.build'
-
-[tool.hatch.version]
-source = 'versioningit'
-
-[tool.hatch.build.targets.wheel]
-packages = ['./']
-
-[tool.versioningit.vcs]
-match = ['v[0-9]*.[0-9]*.[0-9]*']

py/lib/redis/__init__.py

@@ -0,0 +1 @@
+from py.lib.redis.client import get_client

py/lib/redis/client.py

@@ -1,6 +1,6 @@
 from redis import StrictRedis
 
-from scwrypts.env import getenv
+from py.lib.scwrypts import getenv
 
 CLIENT = None
 

py/lib/scwrypts/__init__.py

@@ -1,13 +1,6 @@
-'''
-scwrypts
+from py.lib.scwrypts.execute import execute
+from py.lib.scwrypts.getenv import getenv
+from py.lib.scwrypts.interactive import interactive
+from py.lib.scwrypts.run import run
 
-python library functions and invoker for scwrypts
-'''
-
-__all__ = [
-        'scwrypts',
-        'execute',
-        'interactive',
-        ]
-
-from .scwrypts import scwrypts, execute, interactive
+import py.lib.scwrypts.io

py/lib/scwrypts/data/__init__.py

@@ -1 +0,0 @@
-from .converter import convert

py/lib/scwrypts/data/test_converter.py

@@ -1,73 +0,0 @@
-from io import StringIO
-
-from pytest import raises
-
-from scwrypts.test import generate
-
-from .converter import convert
-
-GENERATE_OPTIONS = {
-        'depth': 1,
-        'minimum': -999999,
-        'maximum':  999999,
-        'dict_key_types': {str, int},
-        'csv_columns_minimum': 10,
-        'csv_columns_maximum': 64,
-        'csv_rows_minimum': 10,
-        'csv_rows_maximum': 64,
-        }
-
-INPUT_TYPES  = {'csv', 'json', 'yaml'}
-OUTPUT_TYPES = {'csv', 'json', 'yaml'}
-
-
-def test_convert_to_csv():
-    for input_type in INPUT_TYPES:
-        input_stream = generate(input_type, {
-            **GENERATE_OPTIONS,
-            'data_types': {bool,int,float,str},
-            })
-
-        if isinstance(input_stream, str):
-            input_stream = StringIO(input_stream)
-
-
-        convert(input_stream, input_type, StringIO(), 'csv')
-
-def test_convert_to_json():
-    for input_type in INPUT_TYPES:
-        input_stream = generate(input_type, GENERATE_OPTIONS)
-
-        if isinstance(input_stream, str):
-            input_stream = StringIO(input_stream)
-
-        convert(input_stream, input_type, StringIO(), 'json')
-
-def test_convert_to_yaml():
-    for input_type in INPUT_TYPES:
-        input_stream = generate(input_type, GENERATE_OPTIONS)
-
-        if isinstance(input_stream, str):
-            input_stream = StringIO(input_stream)
-
-        convert(input_stream, input_type, StringIO(), 'yaml')
-
-
-def test_convert_deep_json_to_yaml():
-    input_stream = generate('json', {**GENERATE_OPTIONS, 'depth': 4})
-    convert(input_stream, 'json', StringIO(), 'yaml')
-
-def test_convert_deep_yaml_to_json():
-    input_stream = generate('yaml', {**GENERATE_OPTIONS, 'depth': 4})
-    convert(input_stream, 'yaml', StringIO(), 'json')
-
-
-def test_convert_output_unsupported():
-    for input_type in list(INPUT_TYPES):
-        with raises(ValueError):
-            convert(StringIO(), input_type, StringIO(), generate(str))
-
-def test_convert_input_unsupported():
-    for output_type in list(OUTPUT_TYPES):
-        with raises(ValueError):
-            convert(StringIO(), generate(str), StringIO(), output_type)

py/lib/scwrypts/exceptions.py

@@ -0,0 +1,16 @@
+from argparse import ArgumentError
+
+
+class MissingVariableError(EnvironmentError):
+    def init(self, name):
+        super().__init__(f'Missing required environment variable "{name}"')
+
+
+class ImportedExecutableError(ImportError):
+    def __init__(self):
+        super().__init__('executable only; must run through scwrypts')
+
+
+class MissingFlagAndEnvironmentVariableError(EnvironmentError, ArgumentError):
+    def __init__(self, flags, env_var):
+        super().__init__(f'must provide at least one of : {{ flags: {flags} OR {env_var} }}')

py/lib/scwrypts/execute.py

@@ -1,12 +1,9 @@
 from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter
 
-from scwrypts.io import get_combined_stream, add_io_arguments
+from py.lib.scwrypts.io import get_combined_stream, add_io_arguments
 
 
-def execute(main, description=None, parse_args=None, allow_input=True, allow_output=True):
-    '''
-    API to initiate a python-based scwrypt
-    '''
+def execute(main, description=None, parse_args=None, toggle_input=True, toggle_output=True):
     if parse_args is None:
         parse_args = []
 
@@ -15,7 +12,7 @@ def execute(main, description=None, parse_args=None, allow_input=True, allow_out
             formatter_class = ArgumentDefaultsHelpFormatter,
             )
 
-    add_io_arguments(parser, allow_input, allow_output)
+    add_io_arguments(parser, toggle_input, toggle_output)
 
     for a in parse_args:
         parser.add_argument(*a[0], **a[1])

py/lib/scwrypts/fzf/__init__.py

@@ -1 +0,0 @@
-from .client import fzf, fzf_tail, fzf_head

py/lib/scwrypts/getenv.py

@@ -1,6 +1,6 @@
 from os import getenv as os_getenv
 
-from .scwrypts.exceptions import MissingVariableError
+from py.lib.scwrypts.exceptions import MissingVariableError
 
 
 def getenv(name, required=True):

py/lib/scwrypts/http/__init__.py

@@ -1 +0,0 @@
-from .client import get_request_client

py/lib/scwrypts/http/client.py

@@ -1,25 +0,0 @@
-from requests import request
-
-
-CLIENTS = {}
-
-def get_request_client(base_url, headers=None):
-    if CLIENTS.get(base_url, None) is None:
-        if headers is None:
-            headers = {}
-
-        CLIENTS[base_url] = lambda method, endpoint, **kwargs: request(
-                method = method,
-                url = f'{base_url}/{endpoint}',
-                headers = {
-                    **headers,
-                    **kwargs.get('headers', {}),
-                    },
-                **{
-                    key: value
-                    for key, value in kwargs.items()
-                    if key != 'headers'
-                    },
-                )
-
-    return CLIENTS[base_url]

py/lib/scwrypts/http/conftest.py

@@ -1,43 +0,0 @@
-from types import SimpleNamespace
-
-from pytest import fixture
-
-from scwrypts.test import generate
-from scwrypts.test.character_set import uri
-
-options = {
-        'str_length_minimum':   8,
-        'str_length_maximum': 128,
-        'uuid_output_type':   str,
-        }
-
-def get_request_client_sample_data():
-    return {
-            'base_url' : generate(str, options | {'character_set': uri}),
-            'endpoint' : generate(str, options | {'character_set': uri}),
-            'method'   : generate(str, options),
-            'response' : generate('requests_Response', options | {'depth': 4}),
-            'payload'  : generate(dict, {
-                **options,
-                'depth': 1,
-                'data_types': { str, 'uuid' },
-                }),
-            }
-
-@fixture(name='sample')
-def fixture_sample():
-    return SimpleNamespace(
-            **get_request_client_sample_data(),
-
-            headers = generate(dict, {
-                **options,
-                'depth': 1,
-                'data_types': { str, 'uuid' },
-                }),
-
-            payload_headers = generate(dict, {
-                **options,
-                'depth': 1,
-                'data_types': { str, 'uuid' },
-                }),
-            )

py/lib/scwrypts/http/directus/client.py

@@ -1,12 +0,0 @@
-from scwrypts.env import getenv
-
-from .. import get_request_client
-
-
-def request(method, endpoint, **kwargs):
-    return get_request_client(
-            base_url = getenv("DIRECTUS__BASE_URL"),
-            headers = {
-                'Authorization': f'bearer {getenv("DIRECTUS__API_TOKEN")}',
-                }
-            )(method, endpoint, **kwargs)

py/lib/scwrypts/http/directus/collections.py

@@ -1,18 +0,0 @@
-from .client import request
-
-
-COLLECTIONS = None
-
-def get_collections():
-    global COLLECTIONS # pylint: disable=global-statement
-
-    if COLLECTIONS is None:
-        COLLECTIONS = [
-            item['collection']
-            for item in request(
-                'GET',
-                'collections?limit=-1&fields[]=collection',
-                ).json()['data']
-            ]
-
-    return COLLECTIONS

py/lib/scwrypts/http/directus/conftest.py

@@ -1,16 +0,0 @@
-from types import SimpleNamespace
-
-from pytest import fixture
-
-from scwrypts.test import generate
-from scwrypts.test.character_set import uri
-from ..conftest import options, get_request_client_sample_data
-
-
-@fixture(name='sample')
-def fixture_sample():
-    return SimpleNamespace(
-            **get_request_client_sample_data(),
-            api_token = generate(str, options | {'character_set': uri}),
-            query     = generate(str, options),
-            )

py/lib/scwrypts/http/directus/fields.py

@@ -1,16 +0,0 @@
-from .client import request
-
-
-FIELDS      = {}
-
-def get_fields(collection):
-    if FIELDS.get(collection) is None:
-        FIELDS[collection] = [
-                item['field']
-                for item in request(
-                    'GET',
-                    f'fields/{collection}?limit=-1&fields[]=field',
-                    ).json()['data']
-                ]
-
-    return FIELDS[collection]

py/lib/scwrypts/http/directus/graphql.py

@@ -1,9 +0,0 @@
-from .client import request
-
-
-def graphql(query, system=False):
-    return request(
-            'POST',
-            'graphql' if system is False else 'graphql/system',
-            json={'query': query},
-            )

py/lib/scwrypts/http/directus/test_client.py

@@ -1,43 +0,0 @@
-from unittest.mock import patch
-
-from pytest import fixture
-
-from .client import request
-
-
-def test_directus_request(sample, _response):
-    assert _response == sample.response
-
-def test_directus_request_client_setup(sample, _response, mock_get_request_client):
-    mock_get_request_client.assert_called_once_with(
-            base_url = sample.base_url,
-            headers = { 'Authorization': f'bearer {sample.api_token}' },
-            )
-
-
-#####################################################################
-
-@fixture(name='_response')
-def fixture_response(sample):
-    return request(
-            method   = sample.method,
-            endpoint = sample.endpoint,
-            **sample.payload,
-            )
-
-#####################################################################
-
-@fixture(name='mock_getenv', autouse=True)
-def fixture_mock_getenv(sample):
-    with patch('scwrypts.http.directus.client.getenv',) as mock:
-        mock.side_effect = lambda name: {
-                'DIRECTUS__BASE_URL': sample.base_url,
-                'DIRECTUS__API_TOKEN': sample.api_token,
-                }[name]
-        yield mock
-
-@fixture(name='mock_get_request_client', autouse=True)
-def fixture_mock_get_request_client(sample):
-    with patch('scwrypts.http.directus.client.get_request_client') as mock:
-        mock.return_value = lambda method, endpoint, **kwargs: sample.response
-        yield mock

py/lib/scwrypts/http/directus/test_graphql.py

@@ -1,45 +0,0 @@
-from unittest.mock import patch
-
-from pytest import fixture
-
-from .graphql import graphql
-
-
-def test_directus_graphql(sample, _response, _mock_request):
-    assert _response == sample.response
-
-def test_directus_graphql_request_payload(sample, _response, _mock_request):
-    _mock_request.assert_called_once_with(
-            'POST',
-            'graphql',
-            json = {'query': sample.query},
-            )
-
-def test_directus_graphql_system(sample, _response_system):
-    assert _response_system == sample.response
-
-def test_directus_graphql_system_request_payload(sample, _response_system, _mock_request):
-    _mock_request.assert_called_once_with(
-            'POST',
-            'graphql/system',
-            json = {'query': sample.query},
-            )
-
-#####################################################################
-
-@fixture(name='_response')
-def fixture_response(sample, _mock_request):
-    return graphql(sample.query)
-
-
-@fixture(name='_response_system')
-def fixture_response_system(sample, _mock_request):
-    return graphql(sample.query, system=True)
-
-#####################################################################
-
-@fixture(name='_mock_request')
-def fixture_mock_request(sample):
-    with patch('scwrypts.http.directus.graphql.request') as mock:
-        mock.return_value = sample.response
-        yield mock

py/lib/scwrypts/http/discord/__init__.py

@@ -1,14 +0,0 @@
-'''
-basic scwrypts.http client for discord
-
-configured by setting various DISCORD__* options in the
-scwrypts environment
-'''
-
-__all__ = [
-        'request',
-        'send_message',
-        ]
-
-from .client import request
-from .send_message import send_message

py/lib/scwrypts/http/discord/client.py

@@ -1,15 +0,0 @@
-from scwrypts.env import getenv
-
-from .. import get_request_client
-
-
-def request(method, endpoint, **kwargs):
-    headers = {}
-
-    if (token := getenv("DISCORD__BOT_TOKEN", required = False)) is not None:
-        headers['Authorization'] = f'Bot {token}'
-
-    return get_request_client(
-            base_url = 'https://discord.com/api',
-            headers = headers,
-            )(method, endpoint, **kwargs)

py/lib/scwrypts/http/discord/conftest.py

@@ -1,25 +0,0 @@
-from string import ascii_letters, digits
-from types import SimpleNamespace
-
-from pytest import fixture
-
-from scwrypts.test import generate
-from scwrypts.test.character_set import uri
-from ..conftest import options, get_request_client_sample_data
-
-@fixture(name='sample')
-def fixture_sample():
-    return SimpleNamespace(
-            **{
-                **get_request_client_sample_data(),
-                'base_url': 'https://discord.com/api',
-                },
-            bot_token  = generate(str, options | {'character_set': uri}),
-            username   = generate(str, options | {'character_set': ascii_letters + digits}),
-            avatar_url = generate(str, options | {'character_set': uri}),
-            webhook    = generate(str, options | {'character_set': uri}),
-            channel_id = generate(str, options | {'character_set': uri}),
-            content_header = generate(str, options),
-            content_footer = generate(str, options),
-            content = generate(str, options),
-        )

py/lib/scwrypts/http/discord/test_client.py

@@ -1,54 +0,0 @@
-from unittest.mock import patch
-
-from pytest import fixture
-
-from .client import request
-
-
-def test_discord_request(sample, _response):
-    assert _response == sample.response
-
-def test_discord_request_client_setup(sample, mock_get_request_client, _mock_getenv, _response):
-    mock_get_request_client.assert_called_once_with(
-            base_url = sample.base_url,
-            headers = { 'Authorization': f'Bot {sample.bot_token}' },
-            )
-
-def test_discord_request_client_setup_public(sample, mock_get_request_client, _mock_getenv_optional, _response):
-    mock_get_request_client.assert_called_once_with(
-            base_url = sample.base_url,
-            headers = {},
-            )
-
-
-#####################################################################
-
-@fixture(name='_response')
-def fixture_response(sample):
-    return request(
-            method   = sample.method,
-            endpoint = sample.endpoint,
-            **sample.payload,
-            )
-
-#####################################################################
-
-@fixture(name='mock_get_request_client', autouse=True)
-def fixture_mock_get_request_client(sample):
-    with patch('scwrypts.http.discord.client.get_request_client') as mock:
-        mock.return_value = lambda method, endpoint, **kwargs: sample.response
-        yield mock
-
-@fixture(name='_mock_getenv')
-def fixture_mock_getenv(sample):
-    with patch('scwrypts.http.discord.client.getenv',) as mock:
-        mock.side_effect = lambda name, **kwargs: {
-                'DISCORD__BOT_TOKEN': sample.bot_token,
-                }[name]
-        yield mock
-
-@fixture(name='_mock_getenv_optional')
-def fixture_mock_getenv_optional():
-    with patch('scwrypts.http.discord.client.getenv',) as mock:
-        mock.side_effect = lambda name, **kwargs: None
-        yield mock

py/lib/scwrypts/http/discord/test_send_message.py

@@ -1,91 +0,0 @@
-from unittest.mock import patch
-
-from pytest import fixture, raises
-
-from .send_message import send_message
-
-
-def test_discord_send_message(sample, mock_request, _mock_getenv):
-    expected = get_default_called_with(sample)
-
-    assert send_message(sample.content) == sample.response
-    mock_request.assert_called_once_with(**expected)
-
-def test_discord_send_message_without_username(sample, mock_request, _mock_getenv):
-    sample.username = None
-    expected = get_default_called_with(sample)
-    del expected['json']['username']
-
-    assert send_message(sample.content) == sample.response
-    mock_request.assert_called_once_with(**expected)
-
-def test_discord_send_message_without_avatar_url(sample, mock_request, _mock_getenv):
-    sample.avatar_url = None
-    expected = get_default_called_with(sample)
-    del expected['json']['avatar_url']
-
-    assert send_message(sample.content) == sample.response
-    mock_request.assert_called_once_with(**expected)
-
-def test_discord_send_message_to_channel_id(sample, mock_request, _mock_getenv):
-    sample.webhook = None
-    expected = get_default_called_with(sample)
-    expected['endpoint'] = f'channels/{sample.channel_id}/messages'
-
-    assert send_message(sample.content) == sample.response
-    mock_request.assert_called_once_with(**expected)
-
-def test_discord_send_message_without_content_header(sample, mock_request, _mock_getenv):
-    sample.content_header = None
-    expected = get_default_called_with(sample)
-    expected['json']['content'] = f'{sample.content}{sample.content_footer}'
-
-    assert send_message(sample.content) == sample.response
-    mock_request.assert_called_once_with(**expected)
-
-def test_discord_send_message_without_content_footer(sample, mock_request, _mock_getenv):
-    sample.content_footer = None
-    expected = get_default_called_with(sample)
-    expected['json']['content'] = f'{sample.content_header}{sample.content}'
-
-    assert send_message(sample.content) == sample.response
-    mock_request.assert_called_once_with(**expected)
-
-def test_discord_send_message_error(sample, mock_request, _mock_getenv):
-    with raises(ValueError):
-        sample.webhook = None
-        sample.channel_id = None
-
-        send_message(sample.content)
-
-#####################################################################
-
-def get_default_called_with(sample):
-    return {
-            'method': 'POST',
-            'endpoint': f'webhooks/{sample.webhook}',
-            'json': {
-                'content': f'{sample.content_header}{sample.content}{sample.content_footer}',
-                'username': sample.username,
-                'avatar_url': sample.avatar_url,
-                },
-            }
-
-@fixture(name='mock_request', autouse=True)
-def fixture_mock_request(sample):
-    with patch('scwrypts.http.discord.send_message.request') as mock:
-        mock.return_value = sample.response
-        yield mock
-
-@fixture(name='_mock_getenv')
-def fixture_mock_getenv(sample):
-    with patch('scwrypts.http.discord.send_message.getenv',) as mock:
-        mock.side_effect = lambda name, **kwargs: {
-                'DISCORD__DEFAULT_USERNAME': sample.username,
-                'DISCORD__DEFAULT_AVATAR_URL': sample.avatar_url,
-                'DISCORD__DEFAULT_WEBHOOK': sample.webhook,
-                'DISCORD__DEFAULT_CHANNEL_ID': sample.channel_id,
-                'DISCORD__CONTENT_HEADER': sample.content_header,
-                'DISCORD__CONTENT_FOOTER': sample.content_footer,
-                }[name]
-        yield mock

py/lib/scwrypts/http/linear/__init__.py

@@ -1,14 +0,0 @@
-'''
-basic scwrypts.http client for linear
-
-configured by setting the LINEAR__API_TOKEN option in the
-scwrypts environment
-'''
-
-__all__ = [
-        'request',
-        'graphql',
-        ]
-
-from .client import request
-from .graphql import graphql

py/lib/scwrypts/http/linear/client.py

@@ -1,12 +0,0 @@
-from scwrypts.env import getenv
-
-from .. import get_request_client
-
-
-def request(method, endpoint, **kwargs):
-    return get_request_client(
-            base_url = 'https://api.linear.app',
-            headers = {
-                'Authorization': f'bearer {getenv("LINEAR__API_TOKEN")}',
-                },
-            )(method, endpoint, **kwargs)

py/lib/scwrypts/http/linear/conftest.py

@@ -1,19 +0,0 @@
-from string import ascii_letters, digits
-from types import SimpleNamespace
-
-from pytest import fixture
-
-from scwrypts.test import generate
-from scwrypts.test.character_set import uri
-from ..conftest import options, get_request_client_sample_data
-
-@fixture(name='sample')
-def fixture_sample():
-    return SimpleNamespace(
-            **{
-                **get_request_client_sample_data(),
-                'base_url': 'https://api.linear.app',
-                },
-            api_token = generate(str, options | {'character_set': uri}),
-            query     = generate(str, options),
-        )

py/lib/scwrypts/http/linear/graphql.py

@@ -1,5 +0,0 @@
-from .client import request
-
-
-def graphql(query):
-    return request('POST', 'graphql', json={'query': query})

py/lib/scwrypts/http/linear/test_client.py

@@ -1,42 +0,0 @@
-from unittest.mock import patch
-
-from pytest import fixture
-
-from .client import request
-
-
-def test_discord_request(sample, _response):
-    assert _response == sample.response
-
-def test_discord_request_client_setup(sample, mock_get_request_client, _response):
-    mock_get_request_client.assert_called_once_with(
-            base_url = sample.base_url,
-            headers = { 'Authorization': f'bearer {sample.api_token}' },
-            )
-
-
-#####################################################################
-
-@fixture(name='_response')
-def fixture_response(sample):
-    return request(
-            method   = sample.method,
-            endpoint = sample.endpoint,
-            **sample.payload,
-            )
-
-#####################################################################
-
-@fixture(name='mock_get_request_client', autouse=True)
-def fixture_mock_get_request_client(sample):
-    with patch('scwrypts.http.linear.client.get_request_client') as mock:
-        mock.return_value = lambda method, endpoint, **kwargs: sample.response
-        yield mock
-
-@fixture(name='mock_getenv', autouse=True)
-def fixture_mock_getenv(sample):
-    with patch('scwrypts.http.linear.client.getenv',) as mock:
-        mock.side_effect = lambda name, **kwargs: {
-                'LINEAR__API_TOKEN': sample.api_token,
-                }[name]
-        yield mock

py/lib/scwrypts/http/linear/test_graphql.py

@@ -1,35 +0,0 @@
-from unittest.mock import patch
-
-from pytest import fixture
-
-from .graphql import graphql
-
-
-def test_directus_graphql(sample, _response, _mock_request):
-    assert _response == sample.response
-
-def test_directus_graphql_request_payload(sample, _response, _mock_request):
-    _mock_request.assert_called_once_with(
-            'POST',
-            'graphql',
-            json = {'query': sample.query},
-            )
-
-#####################################################################
-
-@fixture(name='_response')
-def fixture_response(sample, _mock_request):
-    return graphql(sample.query)
-
-
-@fixture(name='_response_system')
-def fixture_response_system(sample, _mock_request):
-    return graphql(sample.query)
-
-#####################################################################
-
-@fixture(name='_mock_request')
-def fixture_mock_request(sample):
-    with patch('scwrypts.http.linear.graphql.request') as mock:
-        mock.return_value = sample.response
-        yield mock

py/lib/scwrypts/http/test_client.py

@@ -1,55 +0,0 @@
-from unittest.mock import patch
-
-from pytest import fixture
-
-from .client import get_request_client
-
-
-def test_request_client(sample, _response_basic):
-    assert _response_basic == sample.response
-
-def test_request_client_forwards_default_headers(sample, mock_request, _response_basic):
-    mock_request.assert_called_once_with(
-            method = sample.method,
-            url = f'{sample.base_url}/{sample.endpoint}',
-            headers = sample.headers,
-            )
-
-def test_get_request_client_payload(sample, _response_payload):
-    assert _response_payload == sample.response
-
-def test_request_client_forwards_payload_headers(sample, mock_request, _response_payload):
-    assert mock_request.call_args.kwargs['headers'] == sample.headers | sample.payload_headers
-
-
-#####################################################################
-
-@fixture(name='mock_request', autouse=True)
-def fixture_mock_request(sample):
-    with patch('scwrypts.http.client.request') as mock:
-        mock.return_value = sample.response
-        yield mock
-
-@fixture(name='request_client', autouse=True)
-def fixture_request_client(sample):
-    return get_request_client(sample.base_url, sample.headers)
-
-#####################################################################
-
-@fixture(name='_response_basic')
-def fixture_response_basic(sample, request_client):
-    return request_client(
-            method   = sample.method,
-            endpoint = sample.endpoint,
-            )
-
-@fixture(name='_response_payload')
-def fixture_response_payload(sample, request_client):
-    return request_client(
-            method   = sample.method,
-            endpoint = sample.endpoint,
-            **{
-                **sample.payload,
-                'headers': sample.payload_headers,
-                },
-            )

py/lib/scwrypts/interactive.py

@@ -2,9 +2,6 @@ from bpython import embed
 
 
 def interactive(variable_descriptions):
-    '''
-    main() decorator to drop to interactive python environment upon completion
-    '''
     def outer(function):
 
         def inner(*args, **kwargs):

py/lib/scwrypts/io.py

@@ -2,47 +2,7 @@ from contextlib import contextmanager
 from pathlib import Path
 from sys import stdin, stdout, stderr
 
-from scwrypts.env import getenv
-
-
-@contextmanager
-def get_combined_stream(input_file=None, output_file=None):
-    '''
-    context manager to open an "input_file" and "output_file"
-
-    But the "files" can be pipe-streams, stdin/stdout, or even
-    actual files! Helpful when trying to write CLI scwrypts
-    which would like to accept all kinds of input and output
-    configurations.
-    '''
-    with get_stream(input_file, 'r') as input_stream, get_stream(output_file, 'w+') as output_stream:
-        yield CombinedStream(input_stream, output_stream)
-
-def add_io_arguments(parser, allow_input=True, allow_output=True):
-    '''
-    slap these puppies onto your argparse.ArgumentParser to
-    allow easy use of the get_combined_stream at the command line
-    '''
-    if allow_input:
-        parser.add_argument(
-                '-i', '--input-file',
-                dest     = 'input_file',
-                default  = None,
-                help     = 'path to input file; omit for stdin',
-                required = False,
-                )
-
-    if allow_output:
-        parser.add_argument(
-                '-o', '--output-file',
-                dest     = 'output_file',
-                default  = None,
-                help     = 'path to output file; omit for stdout',
-                required = False,
-                )
-
-
-#####################################################################
+from py.lib.scwrypts.getenv import getenv
 
 
 @contextmanager
@@ -74,6 +34,32 @@ def get_stream(filename=None, mode='r', encoding='utf-8', verbose=False, **kwarg
             stdout.flush()
 
 
+def add_io_arguments(parser, toggle_input=True, toggle_output=True):
+    if toggle_input:
+        parser.add_argument(
+                '-i', '--input-file',
+                dest     = 'input_file',
+                default  = None,
+                help     = 'path to input file; omit for stdin',
+                required = False,
+                )
+
+    if toggle_output:
+        parser.add_argument(
+                '-o', '--output-file',
+                dest     = 'output_file',
+                default  = None,
+                help     = 'path to output file; omit for stdout',
+                required = False,
+                )
+
+
+@contextmanager
+def get_combined_stream(input_file=None, output_file=None):
+    with get_stream(input_file, 'r') as input_stream, get_stream(output_file, 'w+') as output_stream:
+        yield CombinedStream(input_stream, output_stream)
+
+
 class CombinedStream:
     def __init__(self, input_stream, output_stream):
         self.input = input_stream

py/lib/scwrypts/io/__init__.py

@@ -1 +0,0 @@
-from .combined_io_stream import get_combined_stream, add_io_arguments

py/lib/scwrypts/redis/__init__.py

@@ -1 +0,0 @@
-from .client import get_client

py/lib/scwrypts/run.py

@@ -0,0 +1,22 @@
+from os import getenv
+from pathlib import Path
+from subprocess import run as subprocess_run
+
+
+def run(scwrypt_name, *args):
+    DEPTH = int(getenv('SUBSCWRYPT', '0'))
+    DEPTH += 1
+
+    SCWRYPTS_EXE = Path(__file__).parents[3] / 'scwrypts'
+    ARGS = ' '.join([str(x) for x in args])
+    print(f'SUBSCWRYPT={DEPTH} {SCWRYPTS_EXE} {scwrypt_name} -- {ARGS}')
+
+    print(f'\n {"--"*DEPTH} ({DEPTH}) BEGIN SUBSCWRYPT : {Path(scwrypt_name).name}')
+    subprocess_run(
+        f'SUBSCWRYPT={DEPTH} {SCWRYPTS_EXE} {scwrypt_name} -- {ARGS}',
+        shell=True,
+        executable='/bin/zsh',
+        check=False,
+        )
+
+    print(f' {"--"*DEPTH} ({DEPTH}) END SUBSCWRYPT   : {Path(scwrypt_name).name}\n')

py/lib/scwrypts/scwrypts/__init__.py

@@ -1,23 +0,0 @@
-'''
-scwrypts meta-configuration
-
-provides a helpful three ways to run "scwrypts"
-
- 'scwrypts' is an agnostic, top-level executor allowing any scwrypt to be called from python workflows
-
- 'execute' is the default context set-up for python-based scwrypts
-
- 'interactive' is a context set-up for interactive, python-based scwrypts
-   after execution, you are dropped in a bpython shell with all the variables
-   configured during main() execution
-'''
-
-__all__ = [
-        'scwrypts',
-        'execute',
-        'interactive',
-        ]
-
-from .scwrypts import scwrypts
-from .execute import execute
-from .interactive import interactive

py/lib/scwrypts/scwrypts/exceptions.py

@@ -1,26 +0,0 @@
-from argparse import ArgumentError
-
-
-class MissingVariableError(EnvironmentError):
-    def init(self, name):
-        super().__init__(f'Missing required environment variable "{name}"')
-
-
-class MissingFlagAndEnvironmentVariableError(EnvironmentError, ArgumentError):
-    def __init__(self, flags, env_var):
-        super().__init__(f'must provide at least one of : {{ flags: {flags} OR {env_var} }}')
-
-
-class MissingScwryptsExecutableError(EnvironmentError):
-    def __init__(self):
-        super().__init__(f'scwrypts must be installed and available on your PATH')
-
-
-class BadScwryptsLookupError(ValueError):
-    def __init__(self):
-        super().__init__('must provide name/group/type or scwrypt lookup patterns')
-
-
-class MissingScwryptsGroupOrTypeError(ValueError):
-    def __init__(self, group, _type):
-        super().__init__(f'missing required group or type (group={group} | type={_type}')

py/lib/scwrypts/scwrypts/scwrypts.py

@@ -1,48 +0,0 @@
-from os import getenv
-from shutil import which
-from subprocess import run
-
-from .exceptions import MissingScwryptsExecutableError, BadScwryptsLookupError, MissingScwryptsGroupOrTypeError
-
-
-def scwrypts(*args, patterns=None, name=None, group=None, _type=None, log_level=None):
-    '''
-    top-level scwrypts invoker from python
-
-    - patterns allows for pattern-based scwrypt lookup
-    - name/group/type allos for precise-match lookup
-
-    *args should be a list of strings and is forwarded to the
-    invoked scwrypt
-
-    see 'scwrypts --help' for more information
-    '''
-    executable = which('scwrypts')
-    if executable is None:
-        raise MissingScwryptsExecutableError()
-
-    if patterns is None and name is None:
-        raise BadScwryptsLookupError()
-
-    pre_args = []
-
-    if name is None:
-        pre_args += patterns
-    else:
-        pre_args += ['--name', name, '--group', group, '--type', _type]
-        if group is None or _type is None:
-            raise MissingScwryptsGroupOrTypeError(group, _type)
-
-    if log_level is not None:
-        pre_args += ['--log-level', log_level]
-
-    depth = getenv('SUBSCWRYPT', '')
-    if depth != '':
-        depth = int(depth) + 1
-
-    return run(
-        f'SUBSCWRYPT={depth} {executable} {" ".join(pre_args)} -- {" ".join(args)}',
-        shell=True,
-        executable='/bin/zsh',
-        check=False,
-        )

py/lib/scwrypts/test/__init__.py

@@ -1,10 +0,0 @@
-'''
-automated testing utilties, but primarily a random data generator
-'''
-__all__ = [
-        'generate',
-        ]
-
-from .generate import generate
-
-from .character_set import *

py/lib/scwrypts/test/character_set.py

@@ -1,13 +0,0 @@
-'''
-string constants typically used for randomly generated data
-
-the 'string' standard library already contains many character sets,
-but not these :)
-'''
-
-__all__ = [
-        'uri',
-        ]
-
-
-uri = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~:/?#[]@!$&\'()*+,;='

py/lib/scwrypts/test/exceptions.py

@@ -1,10 +0,0 @@
-class GeneratorError(Exception):
-    pass
-
-class NoDataTypeError(GeneratorError, ValueError):
-    def __init__(self):
-        super().__init__('must provide at least one data type (either "data_type" or "data_types")')
-
-class BadGeneratorTypeError(GeneratorError, ValueError):
-    def __init__(self, data_type):
-        super().__init__(f'no generator exists for data type "{data_type}"')

py/lib/scwrypts/test/generate.py

@@ -1,372 +0,0 @@
-from csv import writer, QUOTE_NONNUMERIC
-from io import StringIO
-from json import dumps, loads
-from random import randint, uniform, choice
-from re import sub
-from string import printable
-from typing import Hashable, Callable
-from uuid import uuid4
-
-from requests import Response, status_codes
-from yaml import safe_dump
-
-from .exceptions import NoDataTypeError, BadGeneratorTypeError
-
-
-DEFAULT_OPTIONS = {
-        'data_types': None,
-        'minimum':  0,
-        'maximum': 64,
-        'depth': 1,
-        'character_set': None,
-        'bool_nullable': False,
-        'str_length': None,
-        'str_length_minimum': 0,
-        'str_length_maximum': 64,
-        'uuid_output_type': 'uuid',  # str or 'uuid'
-        'list_length': 8,
-        'set_length': 8,
-        'dict_length': 8,
-        'csv_bool_nullable': True,
-        'csv_columns': None,
-        'csv_columns_minimum': 1,
-        'csv_columns_maximum': 16,
-        'csv_rows': None,
-        'csv_rows_minimum': 2,
-        'csv_rows_maximum': 16,
-        'csv_output_type': 'stringio',  # str or 'stringio'
-        'json_initial_type': dict,  # typically dict or list
-        'json_bool_nullable': True,
-        'json_output_type': 'stringio',  # str or 'stringio'
-        'yaml_initial_type': dict,  # typically dict or list
-        'yaml_bool_nullable': True,
-        'yaml_use_default_flow_style': False,
-        'yaml_output_type': 'stringio',  # str or 'stringio'
-        'requests_response_status_code': status_codes.codes[200],
-        }
-
-def generate(data_type=None, options=None):
-    '''
-    generate random data with the call of a function
-        use data_type to generate a single value
-
-        use options to set generation options (key = type, value = kwargs)
-
-        use options.data_types and omit data_type to generate a random type
-    '''
-    if options is None:
-        options = {}
-
-    options = DEFAULT_OPTIONS | options
-
-    if data_type is None:
-        if options['data_types'] is None or len(options['data_types']) == 0:
-            raise NoDataTypeError()
-
-        return generate(
-                data_type=choice(list(options['data_types'])),
-                options=options,
-                )
-
-    if not isinstance(data_type, str):
-        data_type = data_type.__name__
-
-    if data_type not in Generator.get_supported_data_types():
-        raise BadGeneratorTypeError(data_type)
-
-    return getattr(Generator, f'_{data_type}')(options)
-
-#####################################################################
-
-SUPPORTED_DATA_TYPES = None
-
-class Generator:
-
-    @classmethod
-    def get_supported_data_types(cls):
-        global SUPPORTED_DATA_TYPES  # pylint: disable=global-statement
-
-        if SUPPORTED_DATA_TYPES is None:
-            SUPPORTED_DATA_TYPES = {
-                    sub('^_', '', data_type)
-                    for data_type, method in Generator.__dict__.items()
-                    if isinstance(method, staticmethod)
-                    }
-
-        return SUPPORTED_DATA_TYPES
-
-    #####################################################################
-
-    @classmethod
-    def filter_data_types(cls, options, filters=None):
-        '''
-        returns an options dict with appropriately filtered data_types
-
-        if data_types are not yet defined, starts with all supported data_types
-        '''
-        if options['data_types'] is None:
-            options['data_types'] = Generator.get_supported_data_types()
-
-        if filters is None or len(filters) == 0:
-            return options
-
-        return {
-                **options,
-                'data_types': set(filter(
-                    lambda data_type: all(( f(data_type, options) for f in filters )),
-                    options['data_types'],
-                    )),
-                }
-
-    class Filters:
-        @staticmethod
-        def hashable(data_type, _options):
-            if isinstance(data_type, Callable):
-                return isinstance(data_type(), Hashable)
-            if not isinstance(data_type, str):
-                data_type = data_type.__name__
-            return data_type in { 'bool', 'int', 'float', 'chr', 'str', 'uuid' }
-
-        @staticmethod
-        def filelike(data_type, _options):
-            return data_type in { 'csv', 'json', 'yaml' }
-
-        @staticmethod
-        def complex(data_type, _options):
-            return data_type in { 'requests_Response' }
-
-        @staticmethod
-        def basic(data_type, options):
-            return all([
-                not Generator.Filters.filelike(data_type, options),
-                not Generator.Filters.complex(data_type, options),
-                ])
-
-        @staticmethod
-        def pythonset(data_type, _options):
-            if not isinstance(data_type, str):
-                data_type = data_type.__name__
-            return data_type == 'set'
-
-        @staticmethod
-        def csvsafe(data_type, options):
-            options['depth'] = max(1, options['depth'])
-            return all([
-                Generator.Filters.basic(data_type, options),
-                not Generator.Filters.pythonset(data_type, options),
-                ])
-
-        @staticmethod
-        def jsonsafe(data_type, options):
-            return all([
-                Generator.Filters.basic(data_type, options),
-                not Generator.Filters.pythonset(data_type, options),
-                ])
-
-        @staticmethod
-        def yamlsafe(data_type, options):
-            return all([
-                Generator.Filters.basic(data_type, options),
-                not Generator.Filters.pythonset(data_type, options),
-                ])
-
-    #####################################################################
-
-    @classmethod
-    def get_option_with_range(cls, options, option_key, data_type=int):
-        '''
-        typically an integer range, allows both:
-            - setting a fixed configuration (e.g. 'str_length')
-            - allowing a configuration range (e.g. 'str_length_minimum' and 'str_length_maximum')
-        '''
-        fixed = options.get(option_key, None)
-        if fixed is not None:
-            return fixed
-
-        return generate(data_type, {
-            'minimum': options[f'{option_key}_minimum'],
-            'maximum': options[f'{option_key}_maximum'],
-            })
-
-    #####################################################################
-
-
-    @staticmethod
-    def _bool(options):
-        return choice([True, False, None]) if options['bool_nullable'] else choice([True, False])
-
-
-    @staticmethod
-    def _int(options):
-        return randint(options['minimum'], options['maximum'])
-
-
-    @staticmethod
-    def _float(options):
-        return uniform(options['minimum'], options['maximum'])
-
-
-    @staticmethod
-    def _chr(options):
-        character_set = options['character_set']
-        return choice(character_set) if character_set is not None else chr(randint(0,65536))
-
-
-    @staticmethod
-    def _str(options):
-        return ''.join((
-            generate(chr, options)
-            for _ in range(Generator.get_option_with_range(options, 'str_length'))
-            ))
-
-
-    @staticmethod
-    def _uuid(options):
-        '''
-        creates a UUID object or a str containing a uuid (v4)
-        '''
-        uuid = uuid4()
-        return str(uuid) if options['uuid_output_type'] == str else uuid
-
-
-    @staticmethod
-    def _list(options):
-        if options['depth'] <= 0:
-            return []
-
-        options['depth'] -= 1
-        options = Generator.filter_data_types(options, [
-            Generator.Filters.basic,
-            ])
-
-        return [ generate(None, {**options}) for _ in range(options['list_length']) ]
-
-
-    @staticmethod
-    def _set(options):
-        if options['depth'] <= 0:
-            return set()
-
-        options['depth'] -= 1
-        options = Generator.filter_data_types(options, [
-            Generator.Filters.hashable,
-            ])
-
-        return { generate(None, options) for _ in range(options['set_length']) }
-
-
-    @staticmethod
-    def _dict(options):
-        if options['depth'] <= 0:
-            return {}
-
-        options['depth'] -= 1
-        options = Generator.filter_data_types(options, [
-            Generator.Filters.basic,
-            ])
-
-        key_options = Generator.filter_data_types(options, [
-            Generator.Filters.hashable,
-            ])
-
-        if len(options['data_types']) == 0 or len(key_options['data_types']) == 0:
-            return {}
-
-        return {
-                generate(None, key_options): generate(None, options)
-                for _ in range(options['dict_length'])
-                }
-
-
-    @staticmethod
-    def _csv(options):
-        '''
-        creates a StringIO object containing csv data
-        '''
-        if options['character_set'] is None:
-            options['character_set'] = printable
-
-        options['bool_nullable'] = options['csv_bool_nullable']
-        options = Generator.filter_data_types(options, [
-            Generator.Filters.csvsafe,
-            ])
-
-        columns = Generator.get_option_with_range(options, 'csv_columns')
-        rows    = Generator.get_option_with_range(options, 'csv_rows')
-
-
-        csv = StringIO()
-        csv_writer = writer(csv, quoting=QUOTE_NONNUMERIC)
-
-        options['list_length'] = columns
-
-        [  # pylint: disable=expression-not-assigned
-                csv_writer.writerow(generate(list, options))
-                for _ in range(rows)
-                ]
-
-        csv.seek(0)
-        return csv.getvalue() if options['csv_output_type'] == str else csv
-
-
-    @staticmethod
-    def _json(options):
-        '''
-        creates a StringIO object or str containing json data
-        '''
-
-        if options['character_set'] is None:
-            options['character_set'] = printable
-
-        options['bool_nullable'] = options['json_bool_nullable']
-        options['uuid_output_type'] = str
-        options = Generator.filter_data_types(options, [
-            Generator.Filters.jsonsafe,
-            ])
-
-        json = dumps(generate(
-            options['json_initial_type'],
-            {**options},
-            ))
-
-        return json if options['json_output_type'] == str else StringIO(json)
-
-
-    @staticmethod
-    def _yaml(options):
-        '''
-        creates a StringIO object or str containing yaml data
-        '''
-        if options['character_set'] is None:
-            options['character_set'] = printable
-
-        options['bool_nullable'] = options['yaml_bool_nullable']
-        options['uuid_output_type'] = str
-        options = Generator.filter_data_types(options, [
-            Generator.Filters.yamlsafe,
-            ])
-
-        yaml = StringIO()
-        safe_dump(
-                generate(options['yaml_initial_type'], {**options}),
-                yaml,
-                default_flow_style=options['yaml_use_default_flow_style'],
-                )
-        yaml.seek(0)
-
-        return yaml.getvalue() if options['yaml_output_type'] == str else yaml
-
-    @staticmethod
-    def _requests_Response(options):
-        '''
-        creates a requests.Response-like object containing json data
-        '''
-
-        options['json_output_type'] = str
-
-        response = Response()
-        response.status_code = options['requests_response_status_code']
-        json = loads(generate('json', options))
-        response.json = lambda: json
-
-        return response

py/lib/scwrypts/test/test_generate.py

@@ -1,54 +0,0 @@
-from os import getenv
-from pprint import pprint
-from random import randint
-
-from .generate import generate, Generator
-
-ITERATIONS = int(
-        getenv(
-            'PYTEST_ITERATIONS__scwrypts__test__generator',
-            getenv('PYTEST_ITERATIONS', '99'),  # CI should use at least 999
-            )
-        )
-
-FILE_LIKE_DATA_TYPES = { 'csv', 'json', 'yaml' }
-
-def test_generate():  # generators should be quick and "just work" (no Exceptions)
-    print()
-    for data_type in Generator.get_supported_data_types():
-        print(f'------- {data_type} -------')
-        sample = generate(data_type)
-        pprint(sample.getvalue() if data_type in {'csv', 'json', 'yaml'} else sample)
-        for _ in range(ITERATIONS):
-            generate(data_type)
-
-
-def test_generate_depth_deep():
-    for data_type in Generator.get_supported_data_types():
-        generate(data_type, {'depth': 4})
-
-def test_generate_depth_shallow():
-    for data_type in Generator.get_supported_data_types():
-        generate(data_type, {'depth': randint(-999, 0)})
-
-
-def test_generate_range_all():
-    for data_type in Generator.get_supported_data_types():
-        generate(data_type, {'minimum': -99, 'maximum': 99})
-
-def test_generate_range_positive():
-    for data_type in Generator.get_supported_data_types():
-        generate(data_type, {'minimum':   1, 'maximum': 99})
-
-def test_generate_range_zero():
-    for data_type in Generator.get_supported_data_types():
-        generate(data_type, {'minimum':   3, 'maximum':  3})
-
-def test_generate_range_negative():
-    for data_type in Generator.get_supported_data_types():
-        generate(data_type, {'minimum': -99, 'maximum': -1})
-
-
-def test_generate_bool_nullable():
-    for data_type in Generator.get_supported_data_types():
-        generate(data_type, {'bool_nullable': True})

py/lib/scwrypts/twilio/__init__.py

@@ -1,13 +0,0 @@
-'''
-loads the twilio.rest.Client by referencing TWILIO__API_KEY,
-TWILIO__API_SECRET, and TWILIO__ACCOUNT_SID in your scwrypts
-environment
-'''
-
-__all__ = [
-        'get_client',
-        'send_sms',
-        ]
-
-from .client import get_client
-from .send_sms import send_sms

py/lib/twilio/__init__.py

@@ -0,0 +1,2 @@
+from py.lib.twilio.client import get_client
+from py.lib.twilio.send_sms import send_sms

py/lib/twilio/client.py

@@ -1,6 +1,6 @@
 from twilio.rest import Client
 
-from scwrypts.env import getenv
+from py.lib.scwrypts import getenv
 
 CLIENT = None
 

py/lib/twilio/send_sms.py

@@ -1,7 +1,7 @@
 from json import dumps
 from time import sleep
 
-from .client import get_client
+from py.lib.twilio.client import get_client
 
 
 def send_sms(to, from_, body, max_char_count=300, stream=None):

py/linear/comment.py

@@ -1,22 +1,13 @@
 #!/usr/bin/env python
-from scwrypts import execute
+from py.lib.http.linear import graphql
+from py.lib.scwrypts import execute
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
 #####################################################################
-from scwrypts.http.linear import graphql
-
-
-description = 'comment on an issue in linear.app'
-parse_args = [
-        ( ['-d', '--issue-id'], {
-            'dest'     : 'issue_id',
-            'help'     : 'issue short-code (e.g. CLOUD-319)',
-            'required' : True,
-            }),
-        ( ['-m', '--message'], {
-            'dest'     : 'message',
-            'help'     : 'comment to post to the target issue',
-            'required' : True,
-            }),
-        ]
 
 
 def get_query(args):
@@ -35,6 +26,20 @@ def main(args, stream):
     response = graphql(get_query(args))
     stream.writeline(response)
 
+
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'comment on an inssue in linear.app',
+        parse_args = [
+            ( ['-d', '--issue-id'], {
+                'dest'     : 'issue_id',
+                'help'     : 'issue short-code (e.g. CLOUD-319)',
+                'required' : True,
+                }),
+            ( ['-m', '--message'], {
+                'dest'     : 'message',
+                'help'     : 'comment to post to the target issue',
+                'required' : True,
+                }),
+            ]
+        )

py/redis/interactive.py

@@ -1,14 +1,15 @@
 #!/usr/bin/env python
-from scwrypts import execute
+from py.lib.redis import get_client
+from py.lib.scwrypts import execute, interactive, getenv
+
+from py.lib.scwrypts.exceptions import ImportedExecutableError
+
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
 #####################################################################
-from scwrypts import interactive
-from scwrypts.env import getenv
-from scwrypts.redis import get_client
 
 
-description = 'establishes a redis client in an interactive python shell'
-parse_args = []
-
 @interactive([
         f'r = StrictRedis(\'{getenv("REDIS_HOST")}:{getenv("REDIS_PORT")}\')',
     ])
@@ -19,5 +20,7 @@ def main(_args, _stream):
 
 
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'establishes a redis client in an interactive python shell',
+        parse_args = [],
+        )

py/requirements.txt

@@ -1 +1,5 @@
-./lib
+bpython
+pyfzf
+pyyaml
+redis
+twilio

py/twilio/send-sms.py

@@ -1,38 +1,15 @@
 #!/usr/bin/env python
-from scwrypts import execute
-#####################################################################
 from sys import stderr
 
-from scwrypts.env import getenv
-from scwrypts.twilio import send_sms
+from py.lib.scwrypts import execute, getenv
+from py.lib.twilio import send_sms
 
+from py.lib.scwrypts.exceptions import ImportedExecutableError, MissingFlagAndEnvironmentVariableError
 
-description = 'send a simple SMS through twilio'
-parse_args = [
-        ( ['-t', '--to'], {
-            'dest'     : 'to',
-            'help'     : 'phone number of the receipient',
-            'required' : False,
-            'default'  : getenv('TWILIO__DEFAULT_PHONE_TO', required=False),
-            }),
-        ( ['-f', '--from'], {
-            'dest'     : 'from_',
-            'help'     : 'phone number of the receipient',
-            'required' : False,
-            'default'  : getenv('TWILIO__DEFAULT_PHONE_FROM', required=False),
-            }),
-        ( ['-b', '--body'], {
-            'dest'     : 'body',
-            'help'     : 'message body',
-            'required' : False,
-            }),
-        ( ['--max-char-count'], {
-            'dest'     : 'max_char_count',
-            'help'     : 'separate message into parts by character count (1 < N <= 1500)',
-            'required' : False,
-            'default'  : 300,
-            }),
-        ]
+if __name__ != '__main__':
+    raise ImportedExecutableError()
+
+#####################################################################
 
 def main(args, stream):
     if args.body is None:
@@ -58,5 +35,31 @@ def main(args, stream):
 
 
 #####################################################################
-if __name__ == '__main__':
-    execute(main, description, parse_args)
+execute(main,
+        description = 'send a simple SMS through twilio',
+        parse_args = [
+            ( ['-t', '--to'], {
+                'dest'     : 'to',
+                'help'     : 'phone number of the receipient',
+                'required' : False,
+                'default'  : getenv('TWILIO__DEFAULT_PHONE_TO', required=False),
+                }),
+            ( ['-f', '--from'], {
+                'dest'     : 'from_',
+                'help'     : 'phone number of the receipient',
+                'required' : False,
+                'default'  : getenv('TWILIO__DEFAULT_PHONE_FROM', required=False),
+                }),
+            ( ['-b', '--body'], {
+                'dest'     : 'body',
+                'help'     : 'message body',
+                'required' : False,
+                }),
+            ( ['--max-char-count'], {
+                'dest'     : 'max_char_count',
+                'help'     : 'separate message into parts by character count (1 < N <= 1500)',
+                'required' : False,
+                'default'  : 300,
+                }),
+            ]
+        )

run

@@ -19,12 +19,12 @@ source "${0:a:h}/zsh/lib/import.driver.zsh" || exit 42
 		  runtime
 		    -y, --yes              auto-accept all [yn] prompts through current scwrypt
 		    -e, --env <env-name>   set environment; overwrites SCWRYPTS_ENV
-		    -n                     shorthand for "--log-level 0"
-		    -v, --log-level [0-4]  set scwrypts log level to one of the following:
+		    -n                     shorthand for "--verbosity 0"
+		    -v, --verbosity [0-4]  set scwrypts log level to one of the following:
 			                         0 : only command output and critical failures; skips logfile
 			                         1 : add success / failure messages
 			                         2 : (default) include status update messages
-									 3 : (CI default) include warning messages
+			                         3 : include warning messages
 			                         4 : include debug messages
 
 		  alternate commands
@@ -138,8 +138,8 @@ source "${0:a:h}/zsh/lib/import.driver.zsh" || exit 42
 				[[ $1 =~ ^--no-log$ ]] && WARNING 'the --no-log flag is deprecated and will be removed in scwrypts v4.2'
 				;;
 
-			-v | --log-level )
-				[[ $2 =~ ^[0-4]$ ]] || ERROR "invalid setting for log-level '$2'"
+			-v | --verbosity )
+				[[ $2 =~ ^[0-4]$ ]] || ERROR "invalid setting for verbosity '$2'"
 				SCWRYPTS_LOG_LEVEL=$2
 				shift 1
 				;;
@@ -327,10 +327,6 @@ source "${0:a:h}/zsh/lib/import.driver.zsh" || exit 42
 		|| LOGFILE='/dev/null' \
 		;
 
-	local RUN_MODE=normal
-	[[ $LOGFILE      =~ ^/dev/null$ ]] && RUN_MODE=no-logfile
-	[[ $SCWRYPT_NAME =~ interactive ]] && RUN_MODE=interactive
-
 	local HEADER FOOTER
 
 	[[ $SCWRYPTS_LOG_LEVEL -ge 2 ]] && {
@@ -340,7 +336,7 @@ source "${0:a:h}/zsh/lib/import.driver.zsh" || exit 42
 				script    : $SCWRYPT_GROUP $SCWRYPT_TYPE $SCWRYPT_NAME
 				run at    : $(date)
 				config    : $ENV_NAME
-				log level : $SCWRYPTS_LOG_LEVEL
+				verbosity : $SCWRYPTS_LOG_LEVEL
 				\\033[1;33m--- SCWRYPT BEGIN ---------------------------------------------------\\033[0m
 			" | sed 's/^\s\+//; 1d'
 		)
@@ -357,25 +353,16 @@ source "${0:a:h}/zsh/lib/import.driver.zsh" || exit 42
 	### run the scwrypt #################################################
 	#####################################################################
 
-	[ ! $SUBSCWRYPT ] && export SUBSCWRYPT=0
-
 	set -o pipefail
 	{
 		[ $HEADER ] && echo $HEADER
-		case $RUN_MODE in
-			normal )
-				(eval "$RUN_STRING $(printf "%q " "$@")")
-				EXIT_CODE=$?
-				;;
-			no-logfile )
-				eval "$RUN_STRING $(printf "%q " "$@")"
-				EXIT_CODE=$?
-				;;
-			interactive )
+		[[ $LOGFILE =~ ^/dev/null$ ]] && {
 			eval "$RUN_STRING $(printf "%q " "$@")" </dev/tty >/dev/tty 2>&1
 			EXIT_CODE=$?
-				;;
-		esac
+		} || {
+			(eval "$RUN_STRING $(printf "%q " "$@")")
+			EXIT_CODE=$?
+		}
 		[ $FOOTER ] && echo $FOOTER
 		[[ $EXIT_CODE -eq 0 ]] && EXIT_COLOR='32m' || EXIT_COLOR='31m'
 

zsh/lib/scwrypts/virtualenv.module.zsh

@@ -85,6 +85,8 @@ CREATE_VIRTUALENV__scwrypts__py() {
 
 	DEPENDENCIES=(virtualenv) CHECK_ENVIRONMENT || return 1
 
+	local VIRTUALENV_PATH="$1"
+
 	STATUS 'creating python virtualenv'
 	local PY PYTHON
 	for PY in $(echo $SCWRYPTS_PREFERRED_PYTHON_VERSIONS__scwrypts)
@@ -139,6 +141,8 @@ CREATE_VIRTUALENV__scwrypts__zx() {
 
 	DEPENDENCIES=(nodeenv) CHECK_ENVIRONMENT || return 1
 
+	local VIRTUALENV_PATH="$1"
+
 	STATUS 'setting up nodeenv'
 	nodeenv $VIRTUALENV_PATH --node=$SCWRYPTS_NODE_VERSION__scwrypts \
 		&& SUCCESS 'node virtualenv created' \

zsh/lib/utils/io.fzf.zsh

@@ -9,7 +9,7 @@ FZF() {
 	FZF_ARGS+=(--height=50%)
 	FZF_ARGS+=(--layout=reverse)
 
-	local SELECTION=$(fzf ${FZF_ARGS[@]} --prompt "$1 : " ${@:2} 2>/dev/tty)
+	local SELECTION=$(fzf ${FZF_ARGS[@]} --prompt "$1 : " ${@:2})
 	PROMPT "$1"
 
 	[ $BE_QUIET ] || {

zsh/scwrypts/virtualenv/refresh

@@ -18,7 +18,7 @@ MAIN() {
 	
 	REMINDER "
 		this will permanently remove all artifacts for the scwrypts $ENV_TYPE environment
-		(safe unless you have put something important in $(_VIRTUALENV__GET_PATH $ENV_GROUP $ENV_TYPE))
+		(safe unless you have put something important in $(GET_VIRTUALENV_PATH $ENV_GROUP $ENV_TYPE))
 		"
 	
 	Yn "drop and recreate $ENV_TYPE virtual environment?" || ABORT

zx/lib/.gitignore

@@ -1,2 +0,0 @@
-dist/
-node_modules/

zx/lib/.prettierignore

@@ -1,2 +0,0 @@
-dist
-node_modules

zx/lib/package.json

@@ -1,100 +0,0 @@
-{
-	"name": "scwrypts",
-	"main": "dist/index.js",
-	"type": "module",
-	"files": [
-		"dist"
-	],
-	"description": "scwrypts integration for typescript",
-	"scripts": {
-		"build": "rm -rf ./dist && tsc",
-		"test": "jest",
-		"lint": "eslint . && prettier --check src/",
-		"format": "prettier --write src/"
-	},
-	"author": "Wryn (yage) Wagner",
-	"license": "GPL-3.0",
-	"devDependencies": {
-		"@jest/globals": "^29.7.0",
-		"@types/jest": "^29.5.12",
-		"@types/node": "^20.11.19",
-		"@types/uuid": "^9.0.8",
-		"@typescript-eslint/eslint-plugin": "^7.0.2",
-		"@typescript-eslint/parser": "^7.0.2",
-		"eslint": "^8.56.0",
-		"jest": "^29.7.0",
-		"prettier": "^3.2.5",
-		"ts-jest": "^29.1.2",
-		"ts-node": "^10.9.2",
-		"typescript": "^5.3.3",
-		"uuid": "^9.0.1"
-	},
-	"eslintConfig": {
-		"ignorePatterns": [
-			"dist",
-			"node_modules"
-		],
-		"env": {
-			"node": true,
-			"es2021": true
-		},
-		"extends": [
-			"eslint:recommended",
-			"plugin:@typescript-eslint/recommended"
-		],
-		"overrides": [
-			{
-				"env": {
-					"node": true
-				},
-				"files": [
-					".eslintrc.{js,cjs}"
-				],
-				"parserOptions": {
-					"sourceType": "script"
-				}
-			}
-		],
-		"parser": "@typescript-eslint/parser",
-		"parserOptions": {
-			"ecmaVersion": "latest",
-			"sourceType": "module"
-		},
-		"plugins": [
-			"@typescript-eslint"
-		],
-		"rules": {
-			"linebreak-style": [
-				"error",
-				"unix"
-			],
-			"quotes": [
-				"error",
-				"single"
-			],
-			"semi": [
-				"error",
-				"always"
-			],
-			"comma-dangle": [
-				"error",
-				"always-multiline"
-			]
-		}
-	},
-	"prettier": {
-		"printWidth": 120,
-		"singleQuote": true,
-		"trailingComma": "all"
-	},
-	"jest": {
-		"preset": "ts-jest",
-		"clearMocks": true,
-		"moduleNameMapper": {
-			"^(\\.{1,2}/.*)\\.js$": "$1"
-		}
-	},
-	"dependencies": {
-		"execa": "^8.0.1"
-	}
-}

zx/lib/src/index.ts

@@ -1,5 +0,0 @@
-export * from './scwrypts/scwrypts.js';
-
-export { ScwryptsLogLevel } from './scwrypts/types.js';
-
-export type { ScwryptsOptions } from './scwrypts/types.js';

zx/lib/src/scwrypts/get-scwrypts-lookup.test.ts

@@ -1,116 +0,0 @@
-/* eslint-disable  @typescript-eslint/no-explicit-any */
-import { describe, expect, test, beforeEach, jest } from '@jest/globals';
-import { v4 as uuid } from 'uuid';
-
-import * as parseCLIArgs from './parse-cli-args.js';
-
-import { getScwryptsLookup, Errors } from './get-scwrypts-lookup.js';
-
-import type { ScwryptsOptions } from './types.js';
-
-let sample: any;
-beforeEach(() => {
-  sample = {
-    parsedCLIArgs: [uuid(), uuid(), uuid()],
-    spy: {},
-  };
-
-  sample.spy.parseCLIArgs = jest.spyOn(parseCLIArgs, 'parseCLIArgs');
-  sample.spy.parseCLIArgs.mockReturnValue(sample.parsedCLIArgs);
-});
-
-describe('exact', () => {
-  beforeEach(() => {
-    sample.exact = {
-      name: uuid(),
-      group: uuid(),
-      type: uuid(),
-    };
-  });
-
-  test('provides correct lookup', () => {
-    const lookup = getScwryptsLookup(sample.exact as ScwryptsOptions);
-
-    expect(lookup).toEqual({
-      method: 'exact',
-      ...sample.exact,
-    });
-  });
-
-  describe('throws error', () => {
-    test('when missing group', () => {
-      delete sample.exact.group;
-      try {
-        getScwryptsLookup(sample.exact as ScwryptsOptions);
-        expect(true).toBeFalsy();
-      } catch (error) {
-        expect(error).toEqual(Errors.MissingScwryptsExactLookupParametersError);
-      }
-    });
-
-    test('when missing type', () => {
-      delete sample.exact.type;
-      try {
-        getScwryptsLookup(sample.exact as ScwryptsOptions);
-        expect(true).toBeFalsy();
-      } catch (error) {
-        expect(error).toEqual(Errors.MissingScwryptsExactLookupParametersError);
-      }
-    });
-  });
-});
-
-describe('patterns', () => {
-  describe('list', () => {
-    let lookup: any;
-    beforeEach(() => {
-      sample.patterns = {
-        patterns: [uuid(), uuid(), uuid()],
-      };
-
-      lookup = getScwryptsLookup(sample.patterns as ScwryptsOptions);
-    });
-
-    test('provides correct lookup', () => {
-      expect(lookup).toEqual({
-        method: 'patterns',
-        patterns: sample.parsedCLIArgs,
-      });
-    });
-
-    test('parses patterns', () => {
-      expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.patterns.patterns);
-    });
-  });
-
-  describe('string', () => {
-    let lookup: any;
-    beforeEach(() => {
-      sample.patterns = {
-        patterns: uuid(),
-      };
-
-      lookup = getScwryptsLookup(sample.patterns as ScwryptsOptions);
-    });
-
-    test('provides correct lookup', () => {
-      expect(lookup).toEqual({
-        method: 'patterns',
-        patterns: sample.parsedCLIArgs,
-      });
-    });
-
-    test('parses patterns', () => {
-      expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.patterns.patterns);
-    });
-  });
-});
-
-test('throws error when missing name and patterns', () => {
-  try {
-    getScwryptsLookup({} as ScwryptsOptions);
-    expect(true).toBeFalsy();
-  } catch (error) {
-    expect(error).toEqual(Errors.NoScwryptsLookupError);
-  }
-});

zx/lib/src/scwrypts/get-scwrypts-lookup.ts

@@ -1,49 +0,0 @@
-import { parseCLIArgs } from './parse-cli-args.js';
-
-import type { ScwryptsOptions } from './types.js';
-
-export type ScwryptsLookupOptions =
-  | {
-      method: 'exact';
-      name: string;
-      group: string;
-      type: string;
-    }
-  | {
-      method: 'patterns';
-      patterns: string[];
-    };
-
-export const Errors = {
-  NoScwryptsLookupError: {
-    name: 'NoScwryptsLookupError',
-    message: 'no scwrypts lookup parameters provided',
-  },
-  MissingScwryptsExactLookupParametersError: {
-    name: 'MissingScwryptsExactLookupParametersError',
-    message: '"name" option requires "group" and "type" options',
-  },
-};
-
-export const getScwryptsLookup = (options: ScwryptsOptions): ScwryptsLookupOptions => {
-  if (options.name === undefined) {
-    if (options.patterns === undefined || options.patterns.length === 0) {
-      throw Errors.NoScwryptsLookupError;
-    }
-    return {
-      method: 'patterns',
-      patterns: parseCLIArgs(options.patterns),
-    };
-  }
-
-  if (options.group === undefined || options.type === undefined) {
-    throw Errors.MissingScwryptsExactLookupParametersError;
-  }
-
-  return {
-    method: 'exact',
-    name: options.name,
-    group: options.group,
-    type: options.type,
-  };
-};

zx/lib/src/scwrypts/parse-cli-args.test.ts

@@ -1,32 +0,0 @@
-/* eslint-disable  @typescript-eslint/no-explicit-any */
-import { describe, expect, test, beforeEach } from '@jest/globals';
-import { v4 as uuid } from 'uuid';
-
-import { parseCLIArgs } from './parse-cli-args.js';
-
-let sample: any;
-beforeEach(() => {
-  sample = {
-    args: [uuid(), uuid(), uuid()],
-  };
-
-  sample.argstring = sample.args.join(' ');
-});
-
-describe('undefined input', () => {
-  test('produces a string[]', () => {
-    expect(parseCLIArgs(undefined)).toEqual([]);
-  });
-});
-
-describe('string input', () => {
-  test('produces a string[]', () => {
-    expect(parseCLIArgs(sample.argstring)).toEqual(sample.args);
-  });
-});
-
-describe('string[] input', () => {
-  test('produces a string[]', () => {
-    expect(parseCLIArgs(sample.args)).toEqual(sample.args);
-  });
-});

zx/lib/src/scwrypts/parse-cli-args.ts

@@ -1,12 +0,0 @@
-export type CLIArgs = string | string[] | undefined;
-
-export const parseCLIArgs = (args: CLIArgs): string[] => {
-  switch (typeof args) {
-    case 'undefined':
-      return [];
-    case 'string':
-      return args.split(' ');
-    default:
-      return args;
-  }
-};

zx/lib/src/scwrypts/scwrypts.test.ts

@@ -1,155 +0,0 @@
-/* eslint-disable  @typescript-eslint/no-explicit-any */
-import { describe, expect, test, beforeEach, jest } from '@jest/globals';
-import { v4 as uuid } from 'uuid';
-
-import { execa } from 'execa';
-import * as Module_getScwryptsLookup from './get-scwrypts-lookup.js';
-import * as Module_parseCLIArgs from './parse-cli-args.js';
-import { ScwryptsLogLevel } from './types.js';
-
-import { scwrypts } from './scwrypts.js';
-
-jest.mock('execa', () => ({
-  execa: jest.fn(() => Promise.resolve()),
-}));
-
-const env = process.env;
-beforeEach(() => {});
-
-let sample: any;
-beforeEach(() => {
-  sample = {
-    options: {
-      name: uuid(),
-      group: uuid(),
-      type: uuid(),
-      patterns: [uuid(), uuid(), uuid()],
-      log_level: Math.floor(Math.random() * Object.keys(ScwryptsLogLevel).length),
-      args: uuid(),
-    },
-    lookup: {
-      exact: {
-        method: 'exact',
-        name: uuid(),
-        group: uuid(),
-        type: uuid(),
-      },
-      patterns: {
-        method: 'patterns',
-        patterns: [uuid(), uuid(), uuid()],
-      },
-    },
-    env: {
-      SCWRYPTS_EXECUTABLE: uuid(),
-    },
-    parsedCLIArgs: [uuid(), uuid(), uuid()],
-    spy: {},
-  };
-
-  sample.spy.getScwryptsLookup = jest.spyOn(Module_getScwryptsLookup, 'getScwryptsLookup');
-  sample.spy.getScwryptsLookup.mockReturnValue(sample.lookup.exact);
-
-  sample.spy.parseCLIArgs = jest.spyOn(Module_parseCLIArgs, 'parseCLIArgs');
-  sample.spy.parseCLIArgs.mockReturnValue(sample.parsedCLIArgs);
-
-  jest.resetModules();
-  process.env = {
-    ...env,
-    ...sample.env,
-  };
-});
-
-afterEach(() => {
-  process.env = { ...env };
-});
-
-describe('exact lookup', () => {
-  beforeEach(async () => {
-    sample.spy.getScwryptsLookup.mockReturnValue(sample.lookup.exact);
-    await scwrypts(sample.options);
-  });
-
-  test('gets the correct lookup', () => {
-    expect(sample.spy.getScwryptsLookup).toHaveBeenCalledWith(sample.options);
-  });
-
-  test('parses arguments correctly', () => {
-    expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.options.args);
-  });
-
-  test('calls the correct scwrypt', () => {
-    expect(execa).toHaveBeenCalledWith(sample.env.SCWRYPTS_EXECUTABLE, [
-      '--name',
-      sample.lookup.exact.name,
-      '--group',
-      sample.lookup.exact.group,
-      '--type',
-      sample.lookup.exact.type,
-      '--log-level',
-      sample.options.log_level.toString(),
-      '--',
-      ...sample.parsedCLIArgs,
-    ]);
-  });
-});
-
-describe('patterns lookup', () => {
-  beforeEach(async () => {
-    sample.spy.getScwryptsLookup.mockReturnValue(sample.lookup.patterns);
-    await scwrypts(sample.options);
-  });
-
-  test('gets the correct lookup', () => {
-    expect(sample.spy.getScwryptsLookup).toHaveBeenCalledWith(sample.options);
-  });
-
-  test('parses arguments correctly', () => {
-    expect(sample.spy.parseCLIArgs).toHaveBeenCalledWith(sample.options.args);
-  });
-
-  test('calls the correct scwrypt', () => {
-    expect(execa).toHaveBeenCalledWith(sample.env.SCWRYPTS_EXECUTABLE, [
-      ...sample.lookup.patterns.patterns,
-      '--log-level',
-      sample.options.log_level.toString(),
-      '--',
-      ...sample.parsedCLIArgs,
-    ]);
-  });
-});
-
-test('omits --log-level arguments if not provided', async () => {
-  delete sample.options.log_level;
-
-  await scwrypts(sample.options);
-
-  expect(execa).toHaveBeenCalledWith(sample.env.SCWRYPTS_EXECUTABLE, [
-    '--name',
-    sample.lookup.exact.name,
-    '--group',
-    sample.lookup.exact.group,
-    '--type',
-    sample.lookup.exact.type,
-    '--',
-    ...sample.parsedCLIArgs,
-  ]);
-});
-
-test('uses default scwrypts executable SCWRYPTS_EXECUTABLE is not provided', async () => {
-  delete process.env.SCWRYPTS_EXECUTABLE;
-
-  await scwrypts(sample.options);
-
-  expect(execa).toHaveBeenCalledWith('scwrypts', [
-    '--name',
-    sample.lookup.exact.name,
-    '--group',
-    sample.lookup.exact.group,
-    '--type',
-    sample.lookup.exact.type,
-    '--log-level',
-    sample.options.log_level.toString(),
-    '--',
-    ...sample.parsedCLIArgs,
-  ]);
-});

zx/lib/src/scwrypts/scwrypts.ts

@@ -1,31 +0,0 @@
-import { execa } from 'execa';
-
-import { getScwryptsLookup } from './get-scwrypts-lookup.js';
-import { parseCLIArgs } from './parse-cli-args.js';
-
-import type { ScwryptsOptions } from './types.js';
-
-export const scwrypts = async (options: ScwryptsOptions) => {
-  const lookup = getScwryptsLookup(options);
-
-  const scwryptsExecutableArgs: string[] = [];
-
-  switch (lookup.method) {
-    case 'exact':
-      scwryptsExecutableArgs.push('--name', lookup.name, '--group', lookup.group, '--type', lookup.type);
-      break;
-    case 'patterns':
-      scwryptsExecutableArgs.push(...lookup.patterns);
-      break;
-  }
-
-  if (options.log_level !== undefined) {
-    scwryptsExecutableArgs.push('--log-level', options.log_level.toString());
-  }
-
-  return await execa(process.env.SCWRYPTS_EXECUTABLE || 'scwrypts', [
-    ...scwryptsExecutableArgs,
-    '--',
-    ...parseCLIArgs(options.args),
-  ]);
-};

zx/lib/src/scwrypts/types.ts

@@ -1,16 +0,0 @@
-export type ScwryptsOptions = {
-  name: string | undefined;
-  group: string | undefined;
-  type: string | undefined;
-  patterns: string[] | undefined;
-  log_level: ScwryptsLogLevel | undefined;
-  args: string | string[] | undefined;
-};
-
-export enum ScwryptsLogLevel {
-  SILENT = 0,
-  QUIET = 1,
-  NORMAL = 2,
-  WARNING = 3,
-  DEBUG = 4,
-}

zx/lib/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "ES2022",
-    "moduleResolution": "node",
-    "target": "ES2022",
-    "lib": ["ES2022"],
-    "checkJs": true,
-    "declaration": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "outDir": "dist",
-    "resolveJsonModule": true,
-    "skipLibCheck": true,
-    "strict": true
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "dist", "extensions", "**/*.test.ts"]
-}

zx/package.json

@@ -9,8 +9,5 @@
 		"preinstall": "npm i -g zx"
   },
   "author": "yage",
-  "license": "GPL-3.0-or-later",
-  "dependencies": {
-    "scwrypts": "file:lib"
-  }
+  "license": "GPL-3.0-or-later"
 }