gnomish-army-knife (1.5.8)

World of Warcraft polyfills and standardization.

Consider sponsoring development.

(interface documentation)

Python Version Support

This package is tested with the following Python minor versions:

• python3.13
• python3.14

Platform Support

This package is tested on the following platforms:

• ubuntu-latest
• macos-latest
• windows-latest

Introduction

LUA source hosted here for CurseForge integration.

Command-line Options

$ ./venv3.14/bin/gak -h

usage: gak [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]
           {markdown,scan,noop} ...

World of Warcraft polyfills and standardization.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -v, --verbose         set to increase logging verbosity
  -q, --quiet           set to reduce output
  --curses              whether or not to use curses.wrapper when starting
  --no-uvloop           whether or not to disable uvloop as event loop driver
  -C, --dir DIR         execute from a specific directory

commands:
  {markdown,scan,noop}  set of available commands
    markdown            generate Markdown content from class data
    scan                scan the 'World of Warcraft' directory for updates
    noop                command stub (does nothing)

Sub-command Options

markdown

$ ./venv3.14/bin/gak markdown -h

usage: gak markdown [-h] [-o OUTPUT] [-d DATABASE]

options:
  -h, --help            show this help message and exit
  -o, --output OUTPUT   output directory (default: 'gnomish-army-knife-
                        markdown')
  -d, --database DATABASE
                        macro database (default:
                        'package://gnomish_army_knife/macros.yaml')

scan

$ ./venv3.14/bin/gak scan -h

usage: gak scan [-h] [-c CONFIG] [-s STATE] [-e]

options:
  -h, --help           show this help message and exit
  -c, --config CONFIG  path to an optional configuration file (default:
                       'gak.yaml')
  -s, --state STATE    path to the program's state directory (default:
                       '/home/vkottler/.local/state/gak')
  -e, --ephemeral      set to use new, temporary directories when applicable

Internal Dependency Graph

A coarse view of the internal structure and scale of gnomish-army-knife's source. Generated using pydeps (via mk python-deps).