Metadata-Version: 2.4
Name: garner-dict
Version: 0.1.2
Summary: Look up words in the Garner Usage Dictionary from the command-line.
Author-email: Justin McGuire <jm@landedstar.com>
License: MIT License
        
        Copyright (c) 2026 Justin McGuire
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/jmcguire/garner
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: jellyfish<2,>=1.2
Requires-Dist: rich<16,>=15
Provides-Extra: release
Requires-Dist: build>=1.2; extra == "release"
Dynamic: license-file

# Basic installation

If you want to use this tool, just install it through pipx:

`pipx install garner-dict`

Then read the help instructions with `garner -h`.

The basic usage is `garner WORD` to see the usage for WORD, or `garner -s WORD` to search for WORD. The search is pretty generous.

If you want a paged result, pipe it through `less`.

You don't need to read anymore. The rest of this document is for developers.

# Developer Notes

Clone this repo, obviously.

Start with basic python stuff:

```sh
python3 -m venv venv
./venv/bin/python -m pip install -r requirements.txt
```

All the definitions are stored in definitions/, but the tool doesn't use those directly. Instead it uses that to build an SQLite database, and then queries that. (We do this for speed and for searching).

So the first thing you need to do is build the DB.

```
./venv/bin/garner --build
```

Now you can use the tool like normal.

## Tests

Run the tests with:

```sh
./venv/bin/python -m unittest discover -s tests
```

The tests use a small fixture dictionary in `tests/fixtures/definitions` instead of the full set of parsed definition files. They create a temporary SQLite database from those fixture entries and check the core lookup/search behavior against that tiny dictionary.

## Licensing

The code in this repository is MIT licensed. See `LICENSE`.

The dictionary content and bundled definitions are copyrighted by Bryan A.  Garner. See `NOTICE`.

## Releases

Release prep is scripted:

```sh
./scripts/release 1.1.0
```

See `RELEASING.md` for the full release checklist.
