gnomish-army-knife


Namegnomish-army-knife JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/vkottler/gnomish-army-knife
SummaryWorld of Warcraft polyfills and standardization.
upload_time2024-12-29 03:47:50
maintainerNone
docs_urlNone
authorVaughn Kottler
requires_python>=3.12
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <!--
    =====================================
    generator=datazen
    version=3.2.0
    hash=bc442b08a4de7e71140dfc3ebce7b0e1
    =====================================
-->

[![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.1.0](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/vkottler/gnomish-army-knife/workflows/Python%20Package/badge.svg)
[![codecov](https://codecov.io/gh/vkottler/gnomish-army-knife/branch/master/graphs/badge.svg?branch=master)](https://codecov.io/github/vkottler/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.*

## Documentation

### Generated

* By [sphinx-apidoc](https://vkottler.github.io/python/sphinx/gnomish-army-knife)
(What's [`sphinx-apidoc`](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html)?)
* By [pydoc](https://vkottler.github.io/python/pydoc/gnomish_army_knife.html)
(What's [`pydoc`](https://docs.python.org/3/library/pydoc.html)?)

## Python Version Support

This package is tested with the following Python minor versions:

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

## Platform Support

This package is tested on the following platforms:

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

# Introduction

# Command-line Options

```
$ ./venv3.12/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 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.12/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
                        output directory (default: 'gnomish-army-knife-
                        markdown')
  -d DATABASE, --database DATABASE
                        macro database (default:
                        'package://gnomish_army_knife/macros.yaml')

```

### `scan`

```
$ ./venv3.12/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 CONFIG
                        path to an optional configuration file (default:
                        'gak.yaml')
  -s STATE, --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)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/vkottler/gnomish-army-knife",
    "name": "gnomish-army-knife",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": "Vaughn Kottler <vaughn@libre-embedded.com>",
    "keywords": null,
    "author": "Vaughn Kottler",
    "author_email": "Vaughn Kottler <vaughn@libre-embedded.com>",
    "download_url": "https://files.pythonhosted.org/packages/ab/9e/8e5f45c10ed3f58f746b92cd0d5912acf49776fbc9dd4d54cbcb78b0873f/gnomish_army_knife-1.1.0.tar.gz",
    "platform": null,
    "description": "<!--\n    =====================================\n    generator=datazen\n    version=3.2.0\n    hash=bc442b08a4de7e71140dfc3ebce7b0e1\n    =====================================\n-->\n\n[![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)\n\n# gnomish-army-knife ([1.1.0](https://pypi.org/project/gnomish-army-knife/))\n\n[![python](https://img.shields.io/pypi/pyversions/gnomish-army-knife.svg)](https://pypi.org/project/gnomish-army-knife/)\n![Build Status](https://github.com/vkottler/gnomish-army-knife/workflows/Python%20Package/badge.svg)\n[![codecov](https://codecov.io/gh/vkottler/gnomish-army-knife/branch/master/graphs/badge.svg?branch=master)](https://codecov.io/github/vkottler/gnomish-army-knife)\n![PyPI - Status](https://img.shields.io/pypi/status/gnomish-army-knife)\n![Dependents (via libraries.io)](https://img.shields.io/librariesio/dependents/pypi/gnomish-army-knife)\n\n*World of Warcraft polyfills and standardization.*\n\n## Documentation\n\n### Generated\n\n* By [sphinx-apidoc](https://vkottler.github.io/python/sphinx/gnomish-army-knife)\n(What's [`sphinx-apidoc`](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html)?)\n* By [pydoc](https://vkottler.github.io/python/pydoc/gnomish_army_knife.html)\n(What's [`pydoc`](https://docs.python.org/3/library/pydoc.html)?)\n\n## Python Version Support\n\nThis package is tested with the following Python minor versions:\n\n* [`python3.12`](https://docs.python.org/3.12/)\n* [`python3.13`](https://docs.python.org/3.13/)\n\n## Platform Support\n\nThis package is tested on the following platforms:\n\n* `ubuntu-latest`\n* `macos-latest`\n* `windows-latest`\n\n# Introduction\n\n# Command-line Options\n\n```\n$ ./venv3.12/bin/gak -h\n\nusage: gak [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]\n           {markdown,scan,noop} ...\n\nWorld of Warcraft polyfills and standardization.\n\noptions:\n  -h, --help            show this help message and exit\n  --version             show program's version number and exit\n  -v, --verbose         set to increase logging verbosity\n  -q, --quiet           set to reduce output\n  --curses              whether or not to use curses.wrapper when starting\n  --no-uvloop           whether or not to disable uvloop as event loop driver\n  -C DIR, --dir DIR     execute from a specific directory\n\ncommands:\n  {markdown,scan,noop}  set of available commands\n    markdown            generate Markdown content from class data\n    scan                scan the 'World of Warcraft' directory for updates\n    noop                command stub (does nothing)\n\n```\n\n## Sub-command Options\n\n### `markdown`\n\n```\n$ ./venv3.12/bin/gak markdown -h\n\nusage: gak markdown [-h] [-o OUTPUT] [-d DATABASE]\n\noptions:\n  -h, --help            show this help message and exit\n  -o OUTPUT, --output OUTPUT\n                        output directory (default: 'gnomish-army-knife-\n                        markdown')\n  -d DATABASE, --database DATABASE\n                        macro database (default:\n                        'package://gnomish_army_knife/macros.yaml')\n\n```\n\n### `scan`\n\n```\n$ ./venv3.12/bin/gak scan -h\n\nusage: gak scan [-h] [-c CONFIG] [-s STATE] [-e]\n\noptions:\n  -h, --help            show this help message and exit\n  -c CONFIG, --config CONFIG\n                        path to an optional configuration file (default:\n                        'gak.yaml')\n  -s STATE, --state STATE\n                        path to the program's state directory (default:\n                        '/home/vkottler/.local/state/gak')\n  -e, --ephemeral       set to use new, temporary directories when applicable\n\n```\n\n# Internal Dependency Graph\n\nA coarse view of the internal structure and scale of\n`gnomish-army-knife`'s source.\nGenerated using [pydeps](https://github.com/thebjorn/pydeps) (via\n`mk python-deps`).\n\n![gnomish-army-knife's Dependency Graph](im/pydeps.svg)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "World of Warcraft polyfills and standardization.",
    "version": "1.1.0",
    "project_urls": {
        "Homepage": "https://github.com/vkottler/gnomish-army-knife"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "836bc076131d6fca7ce21bb05133ab18307fa6a79b54fb6f2efbbfad02638112",
                "md5": "3dbc878f652b27e119642a5a2781a37f",
                "sha256": "043adc958e55b4983c66ad2a508f2cb834889d5cf02ea764244c540d914fc117"
            },
            "downloads": -1,
            "filename": "gnomish_army_knife-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3dbc878f652b27e119642a5a2781a37f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 57560,
            "upload_time": "2024-12-29T03:47:47",
            "upload_time_iso_8601": "2024-12-29T03:47:47.492086Z",
            "url": "https://files.pythonhosted.org/packages/83/6b/c076131d6fca7ce21bb05133ab18307fa6a79b54fb6f2efbbfad02638112/gnomish_army_knife-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ab9e8e5f45c10ed3f58f746b92cd0d5912acf49776fbc9dd4d54cbcb78b0873f",
                "md5": "b3c196eb4bf7d722064c0404f4c1ce41",
                "sha256": "f39a7efe73115f857754ce5b73d295622dd65b4bc401462a3d4637f49d332534"
            },
            "downloads": -1,
            "filename": "gnomish_army_knife-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b3c196eb4bf7d722064c0404f4c1ce41",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 45484,
            "upload_time": "2024-12-29T03:47:50",
            "upload_time_iso_8601": "2024-12-29T03:47:50.182322Z",
            "url": "https://files.pythonhosted.org/packages/ab/9e/8e5f45c10ed3f58f746b92cd0d5912acf49776fbc9dd4d54cbcb78b0873f/gnomish_army_knife-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-29 03:47:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "vkottler",
    "github_project": "gnomish-army-knife",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gnomish-army-knife"
}
Vaughn Kottler
Elapsed time: 0.56290s