Metadata-Version: 2.4
Name: gnomish-army-knife
Version: 1.5.8
Summary: World of Warcraft polyfills and standardization.
Home-page: https://github.com/libre-embedded/gnomish-army-knife
Author: Libre Embedded
Author-email: Libre Embedded <vaughn@libre-embedded.com>
Maintainer-email: Libre Embedded <vaughn@libre-embedded.com>
License-Expression: MIT
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: vcorelib>=3.5.0
Requires-Dist: runtimepy>=5.10.1
Provides-Extra: test
Requires-Dist: pylint; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: black; extra == "test"
Requires-Dist: ruff; extra == "test"
Requires-Dist: mypy; extra == "test"
Requires-Dist: isort; extra == "test"
Requires-Dist: yamllint; extra == "test"
Requires-Dist: yambs; extra == "test"
Requires-Dist: vmklib>=2.0.3; extra == "test"
Requires-Dist: sphinx; extra == "test"
Requires-Dist: sphinx-book-theme; extra == "test"
Requires-Dist: setuptools-wrapper; extra == "test"
Requires-Dist: types-setuptools; extra == "test"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python

<!--
    =====================================
    generator=datazen
    version=3.2.4
    hash=c58083f55edbdd1264dbbd5e5ed6d30c
    =====================================
-->

[![Gnomish Army Knife Icon](https://wow.zamimg.com/images/wow/icons/large/inv_misc_enggizmos_swissarmy.jpg)](https://www.wowhead.com/item=40772/gnomish-army-knife)

# gnomish-army-knife ([1.5.8](https://pypi.org/project/gnomish-army-knife/))

[![python](https://img.shields.io/pypi/pyversions/gnomish-army-knife.svg)](https://pypi.org/project/gnomish-army-knife/)
![Build Status](https://github.com/libre-embedded/gnomish-army-knife/workflows/Python%20Package/badge.svg)
[![codecov](https://codecov.io/gh/libre-embedded/gnomish-army-knife/branch/master/graphs/badge.svg?branch=master)](https://codecov.io/github/libre-embedded/gnomish-army-knife)
![PyPI - Status](https://img.shields.io/pypi/status/gnomish-army-knife)
![Dependents (via libraries.io)](https://img.shields.io/librariesio/dependents/pypi/gnomish-army-knife)

*World of Warcraft polyfills and standardization.*

Consider [sponsoring development](https://github.com/sponsors/libre-embedded).

([interface documentation](https://libre-embedded.github.io/python/gnomish-army-knife))

## Python Version Support

This package is tested with the following Python minor versions:

* [`python3.13`](https://docs.python.org/3.13/)
* [`python3.14`](https://docs.python.org/3.14/)

## Platform Support

This package is tested on the following platforms:

* `ubuntu-latest`
* `macos-latest`
* `windows-latest`

# Introduction

LUA source hosted [here](https://github.com/vkottler/gak-lua) for
[CurseForge](https://www.curseforge.com/wow) 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](https://github.com/thebjorn/pydeps) (via
`mk python-deps`).

![gnomish-army-knife's Dependency Graph](im/pydeps.svg)
