kjxqz 1.1.2

Word list and anagram solver tools.

KJXQZ is an Apache2 licensed collection of anagram word solver tools.

Quickstart

Installing KJXQZ is simple with pip:

$ pip install kjxqz

You can access documentation in the interpreter with Python’s built-in help function. The help works on modules, classes and methods in KJXQZ.

>>> import kjxqz
>>> help(kjxqz)
>>> kjxqz.load()
>>> results = kjxqz.search(letters='abcdef?', contains='hi')
>>> words = list(kjxqz.isearch(letters='abcdef?', contains='hi'))

Build website assets from the packaged word list:

$ python -m kjxqz
$ python -m kjxqz build

The build updates www/dawg.js, kjxqz/dawg.js, and www/service-worker.js.

Search from the command line:

$ python -m kjxqz abcdef? hi
$ python -m kjxqz search abcdef? hi

Development

Install uv and sync dev dependencies:

$ uv sync --extra dev

Run checks and tests:

$ uv run poe check

Common tasks:

$ uv run poe fmt
$ uv run poe test
$ uv run poe docs
$ uv run poe build-dist

Publishing

The release workflow builds distributions and publishes to PyPI using GitHub Actions Trusted Publishing. Push a tag beginning with v to trigger release.

References

• Reference

Useful Links

• KJXQZ Documentation

• KJXQZ at PyPI

• KJXQZ at Github

• KJXQZ Issue Tracker

KJXQZ License

Copyright 2018-2026 Grant Jenks

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.