Installation

This package requires CPython 3.9 or later.

Installation from PyPI (recommended)

No matter what platform you are on, start with this command for installation:

python -m pip install wordle-boss

Alternatively, install the past-answers dependency:

python -m pip install wordle-boss[past-answers]

Binary wheels are provided for 64-bit Linux, macOS, and Windows Intel platforms, so installation on them should be very straightforward.

If you are on a different platform (such as Windows ARM64), installation will involve building a wheel, which can be a complicated process. You’ll be on your own for that.

Installation from source

An appropriate C compiler must be installed on your OS.

1. Clone and enter the repository:

   git clone https://github.com/PT-Hrothgar/wordle-boss
   cd wordle-boss
   

2. Install with pip:

   python -m pip install .
   

   pip should follow the build instructions in the file pyproject.toml to build a binary wheel, and then install the package from it.

3. Run tests (optional):

   python -m unittest discover -s tests
   

past-answers dependency

This optional project dependency includes the modules requests, Beautiful Soup 4, and html5lib for HTML retrieving and parsing.

To install it, use the following command:

python -m pip install wordle-boss[past-answers]

This will allow the collection of past Wordle answers from online sources using the function get_past_answers().