fmtr.tools 1.1.1__py3-none-any.whl → 1.4.37__py3-none-any.whl

fmtr/tools/tools.py

@@ -27,7 +27,15 @@ def identity(x: Any) -> Any:
     return x
 
 
-class Empty:
+class Special:
+    """
+
+    Classes to differentiate special arguments from primitive arguments.
+
+    """
+
+
+class Empty(Special):
     """
 
     Class to denote an unspecified object (e.g. argument) when `None` cannot be used.
@@ -35,7 +43,7 @@ class Empty:
     """
 
 
-class Raise:
+class Raise(Special):
     """
 
     Class to denote when a function should raise instead of e.g. returning a default.
@@ -43,4 +51,21 @@ class Raise:
     """
 
 
+class Auto(Special):
+    """
+
+    Class to denote when an argument should be inferred.
+
+    """
+
+
+class Required(Special):
+    """
+
+    Class to denote when an argument is required.
+
+    """
+
+
+
 EMPTY = Empty()

fmtr/tools/version

@@ -1 +1 @@
-1.1.1
+1.4.37

fmtr/tools/version_tools/__init__.py

@@ -0,0 +1,12 @@
+from fmtr.tools.import_tools import MissingExtraMockModule
+
+from fmtr.tools.version_tools.version_tools import read, read_path, get
+
+try:
+    import semver
+
+    semver = semver
+    parse = semver.VersionInfo.parse
+
+except ModuleNotFoundError as exception:
+    semver = parse = MissingExtraMockModule('version.dev', exception)

fmtr/tools/version_tools/version_tools.py

@@ -0,0 +1,51 @@
+from fmtr.tools import environment_tools as env
+from fmtr.tools.constants import Constants
+from fmtr.tools.inspection_tools import get_call_path
+
+
+def read() -> str:
+    """
+
+    Read a generic version file from the calling package path.
+
+    """
+
+    path = get_call_path(offset=2).parent / Constants.FILENAME_VERSION
+    return read_path(path)
+
+
+def read_path(path) -> str:
+    """
+
+    Read in version from specified path
+
+    """
+    from fmtr.tools.tools import Constants
+    text = path.read_text(encoding=Constants.ENCODING).strip()
+
+    text = get(text)
+    return text
+
+
+def get(text) -> str:
+    """
+
+    Optionally add dev build info to raw version string.
+
+    """
+
+    if not env.IS_DEV:
+        return text
+
+    import datetime
+    from fmtr.tools.tools import Constants
+    from fmtr.tools.version_tools import parse
+
+    timestamp = datetime.datetime.now(datetime.timezone.utc).strftime(Constants.DATETIME_SEMVER_BUILD_FORMAT)
+
+    version = parse(text)
+    version = version.bump_patch()
+    version = version.replace(prerelease=Constants.DEVELOPMENT, build=timestamp)
+    text = str(version)
+
+    return text

fmtr/tools/webhook_tools.py

@@ -0,0 +1,17 @@
+from fmtr.tools import environment_tools, Constants
+from fmtr.tools.http_tools import client
+
+
+def notify(title, body, url=None):
+    """
+
+    Send simple debug notification
+
+    """
+    url = url or environment_tools.get(Constants.WEBHOOK_URL_NOTIFY_KEY)
+    client.post(url, json=dict(title=title, body=body))
+
+
+if __name__ == '__main__':
+    notify('Title', 'Body')
+    notify

fmtr/tools/yaml_tools.py

@@ -1,12 +1,63 @@
+from functools import lru_cache
 from typing import Any
-from yaml import CLoader as Loader, CDumper as Dumper
-from yaml import load, dump
+from yaml import CDumper as Dumper
+from yaml import dump
 
+try:
+    import yamlscript
+except ImportError:
+    raise  # Raise if even the package isn't installed, to trigger the regular missing extra exception.
+except Exception as exception:
+    pass  # Allow missing binary, so we can install on-demand
+
+
+def install():
+    """
+
+    Installs the YAML Script runtime binary of the specified version.
+
+    """
+    import subprocess
+    from fmtr.tools import logger, packaging
+
+    version = packaging.get_version('yamlscript')
+    logger.warning(f"Installing YAML Script runtime binary version {version}...")
+    result = subprocess.run(f"curl https://yamlscript.org/install | VERSION={version} LIB=1 bash", shell=True, check=True)
+    return result
+
+
+@lru_cache
+def get_module(is_auto=True):
+    """
+
+    Get the YAML Script runtime module, installing the runtime if specified
 
-def to_yaml(obj: Any) -> str:
     """
+    try:
+        import yamlscript
+    except Exception as exception:
+        if not is_auto:
+            raise ImportError(f'YAML Script runtime missing and {is_auto=}. Set to {True} to install.') from exception
+        install()
+        import yamlscript
+    return yamlscript
 
 
+@lru_cache
+def get_interpreter():
+    """
+
+    Fetches and returns a cached instance of the YAMLScript interpreter.
+
+    """
+    module = get_module()
+    interpreter = module.YAMLScript()
+    return interpreter
+
+def to_yaml(obj: Any) -> str:
+    """
+
+    Serialize to YAML
 
     """
     yaml_str = dump(obj, allow_unicode=True, Dumper=Dumper)
@@ -16,8 +67,16 @@ def to_yaml(obj: Any) -> str:
 def from_yaml(yaml_str: str) -> Any:
     """
 
-
+    Deserialize from YAML
 
     """
-    obj = load(yaml_str, Loader=Loader)
+    obj = get_interpreter().load(yaml_str)
     return obj
+
+
+if __name__ == '__main__':
+    from fmtr.tools import Path
+
+    py = Path('hw.yml')
+    data = py.read_yaml()
+    data

fmtr/tools/youtube_tools.py

@@ -0,0 +1,128 @@
+from dataclasses import dataclass
+from functools import cached_property
+from pytubefix import YouTube, Stream, extract, request
+from pytubefix.exceptions import RegexMatchError
+from typing import AsyncIterator, Iterator
+from urllib.error import HTTPError
+
+from fmtr.tools.path_tools.path_tools import Path
+
+Stream = Stream
+
+
+class Video(YouTube):
+    """
+
+    Video stub
+
+    """
+
+
+class AudioStreamDownloadError(Exception):
+    """
+
+    Error downloading audio stream
+
+    """
+    pass
+
+
+@dataclass
+class AudioStreamData:
+    """
+
+    Audio stream download data and progress information
+
+    """
+    message: str | None = None
+    chunk: bytes | None = None
+    percentage: int | None = None
+
+
+class AudioStreamDownloader:
+    """
+
+    Download the highest-bitrate audio stream and write to temp directory.
+
+    """
+
+    def __init__(self, url_or_id: str):
+        """
+
+        Initialise with URL or video ID
+
+        """
+
+        try:
+            self.id = extract.video_id(url_or_id)
+        except RegexMatchError:
+            self.id = url_or_id
+
+        self.path = None
+
+    @cached_property
+    def url(self) -> str:
+        """
+
+        Get URL from ID
+
+        """
+        return f'https://youtube.com/watch?v={self.id}'
+
+    async def download(self) -> AsyncIterator[AudioStreamData]:
+        """
+
+        Download the audio stream and yield chunks and progress information
+
+        """
+
+        yield AudioStreamData(message='Fetching video metadata...')
+        video = Video(self.url)
+
+        yield AudioStreamData('Finding audio streams...')
+
+        audio_streams = video.streams.filter(only_audio=True).order_by('bitrate')
+        if not audio_streams:
+            raise AudioStreamDownloadError(f'Error downloading: no audio streams found in "{video.title}"')
+
+        stream = audio_streams.last()
+        yield AudioStreamData(f'Found highest-bitrate audio stream: {stream.audio_codec}/{stream.subtype}@{stream.abr}')
+
+        self.path = Path.temp() / stream.default_filename
+        if self.path.exists():
+            self.path.unlink()
+
+        if stream.filesize == 0:
+            raise AudioStreamDownloadError(f'Error downloading: empty audio stream found in "{video.title}"')
+
+        yield AudioStreamData('Downloading...')
+
+        with self.path.open('wb') as out_file:
+            for data in self.iter_data(stream):
+                out_file.write(data.chunk)
+                yield data
+
+    def iter_data(self, stream: Stream, chunk_size: int | None = None) -> Iterator[AudioStreamData]:
+        """
+
+        Iterate over chunks of the specified size
+
+        """
+        bytes_total = bytes_remaining = stream.filesize
+
+        if chunk_size:
+            request.default_range_size = chunk_size
+
+        try:
+            stream = request.stream(stream.url)
+        except HTTPError as e:
+            if e.code != 404:
+                raise
+            stream = request.seq_stream(stream.url)
+
+        for chunk in stream:
+            bytes_remaining -= len(chunk)
+            percentage = round(((bytes_total - bytes_remaining) / bytes_total) * 100)
+
+            data = AudioStreamData(chunk=chunk, percentage=percentage)
+            yield data

fmtr_tools-1.4.37.data/scripts/add-service

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+loginctl enable-linger $USER
+
+NAME=$(basename "$FILE")
+
+mkdir -p ~/.config/systemd/user
+cp "$FILE" ~/.config/systemd/user/
+systemctl --user daemon-reload
+systemctl --user enable "$NAME"
+systemctl --user start "$NAME"
+systemctl --user status -l -n 50 "$NAME"

fmtr_tools-1.4.37.data/scripts/add-user-path

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
+source $SCRIPT_DIR/parse-args "$@"
+
+NEW=${NEW:-/home/${USERNAME}/.local/bin/}
+
+PATH="${NEW}:${PATH}"

fmtr_tools-1.4.37.data/scripts/apt-headless

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -e
+
+SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
+source $SCRIPT_DIR/parse-args "$@"
+
+export DEBIAN_FRONTEND=noninteractive
+apt update --yes
+
+# if --full was passed, run full-upgrade
+if [ "${FULL}" = "1" ]; then
+    apt --yes full-upgrade
+fi
+
+# if ARGS is not empty, install the packages
+if [ ${#ARGS[@]} -gt 0 ]; then
+    apt install --yes --no-install-recommends "${ARGS[@]}"
+fi
+
+apt autoremove --yes
+apt clean
+rm -rf /var/lib/apt/lists/*

fmtr_tools-1.4.37.data/scripts/compose-update

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+PROJECT_DIR=/opt/dev/repo/infrastructure/${CONTEXT-gex}/docker/${SERVICE}
+CONTEXT=${CONTEXT-gex}
+
+docker --context "$CONTEXT" compose --project-directory "$PROJECT_DIR" pull
+docker --context "$CONTEXT" compose --project-directory "$PROJECT_DIR" up --detach
+docker --context "$CONTEXT" compose --project-directory "$PROJECT_DIR" logs --follow

fmtr_tools-1.4.37.data/scripts/docker-sandbox

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+#Spin up the container in the background with sleep infinity
+CONTAINER_ID=$(docker run -d \
+  --hostname=sandbox \
+  --user=user \
+  --volume=/opt/dev/:/opt/dev/ \
+  --publish=${PORT-9000}:${PORT-9000} \
+  ${IMAGE-fmtr/python} \
+  bash -c "sleep infinity")
+
+
+# Capture Docker's default name
+DEFAULT_NAME=$(docker inspect --format '{{.Name}}' $CONTAINER_ID | cut -c2-)
+
+# Modify it dynamically (prefix or suffix)
+MODIFIED_NAME="sandbox_${DEFAULT_NAME}"
+docker rename $CONTAINER_ID $MODIFIED_NAME
+
+echo "Started container $MODIFIED_NAME."
+
+#Run the sandbox-init script as root (interactive)
+docker exec \
+  --interactive=true \
+  --tty=true \
+  --user=root \
+  $CONTAINER_ID \
+  /opt/dev/repo/fmtr.tools/scripts/docker-sandbox-init --tools
+
+#Start an interactive bash session as user
+docker exec \
+  --interactive=true \
+  --tty=true \
+  --user=user \
+  --env USER=user \
+  $CONTAINER_ID \
+  bash
+
+# Cleanup
+docker rm -f $MODIFIED_NAME
+echo "Container $MODIFIED_NAME removed."

fmtr_tools-1.4.37.data/scripts/docker-sandbox-init

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -e
+
+SECURE_PATH=$PATH
+
+SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
+source $SCRIPT_DIR/add-user-path --username=user --new=$SCRIPT_DIR
+
+. parse-args "$@"
+
+echo "Setting up sandbox..."
+
+set-password
+set-password --username=user
+
+echo "user ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/sandbox
+echo "Defaults secure_path=\"${SECURE_PATH}\"" >> /etc/sudoers.d/sandbox
+chmod 440 /etc/sudoers.d/sandbox
+
+if [ "$TOOLS" == "1" ]; then
+  sudo -u user -H pip install --user fmtr.tools --upgrade
+fi

fmtr_tools-1.4.37.data/scripts/docs-deploy

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+mkdocs gh-deploy --remote-branch docs --force
+

fmtr_tools-1.4.37.data/scripts/docs-serve

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+mkdocs serve --dev-addr=${HOST-0.0.0.0}:${PORT-8180} --livereload

fmtr_tools-1.4.37.data/scripts/download

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+OUT_OPT=${FILE:+-o "$FILE"}
+[ -z "$FILE" ] && OUT_OPT="-O"
+
+curl -L -C - --retry 5 --retry-delay 5 --retry-connrefused --progress-bar $OUT_OPT "$URL"
+

fmtr_tools-1.4.37.data/scripts/fmtr-test-script

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo "Test Script Ran"

fmtr_tools-1.4.37.data/scripts/ftu

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+pip install fmtr.tools --upgrade

fmtr_tools-1.4.37.data/scripts/ha-addon-launch

@@ -0,0 +1,16 @@
+#!/usr/bin/with-contenv bashio
+
+. parse-args "$@"
+
+bashio::log.info "${NAME} container started."
+
+export FMTR_DEV="$(bashio::config 'fmtr_dev')"
+
+if bashio::var.true "${FMTR_DEV}"; then
+    bashio::log.info "Starting ${NAME} SSH development server"
+    printenv > /addon.env
+    echo "root:password" | chpasswd
+    /usr/sbin/sshd -D -o Port=22 -o PermitRootLogin=yes -o PasswordAuthentication=yes -o AllowTcpForwarding=yes -o LogLevel=VERBOSE
+else
+    ${NAME}
+fi

fmtr_tools-1.4.37.data/scripts/install-browser

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -e
+
+
+sudo -u user /opt/dev/venv/fmtr.tools/bin/python -m pip install fmtr.tools[browsers] --upgrade
+/opt/dev/venv/fmtr.tools/bin/python -m playwright install-deps
+sudo -u user /opt/dev/venv/fmtr.tools/bin/python -m playwright install chromium

fmtr_tools-1.4.37.data/scripts/parse-args

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+ARGS=()  # positional arguments
+
+while [ $# -gt 0 ]; do
+  case "$1" in
+    # --key=value or -k=value
+    --*=* | -*=*)
+      key=${1%%=*}
+      key=${key#--}
+      key=${key#-}
+      key=$(printf '%s' "$key" | tr 'a-z-' 'A-Z_')
+
+      val=${1#*=}
+      export "$key=$val"
+
+      unset key val   # remove temporary variables
+      shift
+      ;;
+    # --key value or -k value, or boolean flag
+    --* | -*)
+      key=${1#--}
+      key=${key#-}
+      key=$(printf '%s' "$key" | tr 'a-z-' 'A-Z_')
+
+      if [ -n "$2" ] && [[ ! "$2" =~ ^- ]]; then
+        val="$2"
+        export "$key=$val"
+        shift 2
+      else
+        export "$key=1"
+        shift
+      fi
+
+      unset key val   # remove temporary variables
+      ;;
+    # positional arguments
+    *)
+      ARGS+=("$1")
+      shift
+      ;;
+  esac
+done

fmtr_tools-1.4.37.data/scripts/set-password

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+echo "${USERNAME-root}:${PASSWORD-password}" | chpasswd

fmtr_tools-1.4.37.data/scripts/snips-install

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+DIR="/home/$(whoami)/.local/bin/"
+REPO="snips"
+BRANCH="main"
+URL="https://github.com/${ORG}/${REPO}/archive/refs/heads/${BRANCH}.zip"
+
+TMPDIR=$(mktemp -d)
+download --url="$URL" --file=$TMPDIR/snips.zip
+unzip $TMPDIR/snips.zip -d $TMPDIR
+mv "$TMPDIR/${REPO}-${BRANCH}/"* "$DIR"
+rm -rf "$TMPDIR"

fmtr_tools-1.4.37.data/scripts/ssh-auth

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+set -e
+
+if [ -z "${USERNAME}" ]; then
+    echo "Error: --username argument is not set" >&2
+    exit 1
+fi
+
+SSH_DIR="$HOME/.ssh"
+AUTHORIZED_KEYS="$SSH_DIR/authorized_keys"
+
+mkdir -p "$SSH_DIR"
+chmod 700 "$SSH_DIR"
+
+TMP_KEYS=$(mktemp)
+curl -fsSL "https://github.com/${USERNAME}.keys" > "$TMP_KEYS"
+
+touch "$AUTHORIZED_KEYS"
+chmod 600 "$AUTHORIZED_KEYS"
+
+grep -Fvx -f "$AUTHORIZED_KEYS" "$TMP_KEYS" >> "$AUTHORIZED_KEYS"
+
+rm "$TMP_KEYS"
+
+echo "SSH keys from '${USERNAME}' added to '${AUTHORIZED_KEYS}'"

fmtr_tools-1.4.37.data/scripts/ssh-serve

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -e
+
+FMTR_DEV_SSH_PORT=${FMTR_DEV_SSH_PORT:-22}
+
+[ -f /home/user/.ssh/ssh_host ] || ssh-keygen -f /home/user/.ssh/ssh_host -N '' -t rsa
+
+exec /usr/sbin/sshd -D -e -p "$FMTR_DEV_SSH_PORT" \
+    -h /home/user/.ssh/ssh_host \
+    -o PasswordAuthentication=no \
+    -o PermitRootLogin=prohibit-password \
+    -o PubkeyAuthentication=yes \
+    -o AuthorizedKeysFile=/home/user/.ssh/authorized_keys \
+    -o LogLevel=VERBOSE

fmtr_tools-1.4.37.data/scripts/vlc-tn

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+if ! command -v vlc >/dev/null 2>&1; then
+    echo "VLC not found. Installing dependencies..."
+    sudo apt-headless vlc-bin vlc-plugin-base
+fi
+
+vlc -I telnet --telnet-password ${PASSWORD-password} --telnet-host ${HOST-0.0.0.0}:${PORT-4212}

fmtr_tools-1.4.37.data/scripts/vm-launch

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+. parse-args "$@"
+
+sudo qemu-system-x86_64 \
+  -enable-kvm \
+  -m ${GB-12}G \
+  -smp ${CPUS-4} \
+  -cpu host \
+  -machine q35 \
+  -drive if=pflash,format=raw,readonly=on,file=/usr/share/OVMF/OVMF_CODE_4M.fd \
+  -drive if=pflash,format=raw,file=/usr/share/OVMF/OVMF_VARS_4M.fd \
+  -drive file=/opt/dev/vm/${NAME-default}/disk.qcow2,format=qcow2,if=virtio,cache=writeback,aio=threads \
+  -device virtio-net-pci,netdev=net0 \
+  -netdev bridge,id=net0,br=${BR-br0} \
+  -display ${DISPLAY_VM-gtk} \
+  -serial mon:stdio