Installation

Important

Installing crossword_puzzle requires Python3 and pip. If you have Python installed without pip, click here to install it.

If you do not have Python installed, download the installer here, or install it with pyenv (recommended). Then, refer to the previous link on how to install pip.

If you are on Linux or MacOS, you may not have Tkinter installed by default. Try running sudo apt-get install python3-tk on Linux or sudo pip install python3-tk on MacOS if this is the case.

Tip

If using python or pip doesn't work, try using python3 or pip3.

1. Make a virtual environment and activate it (recommended):

pip install virtualenv
python -m venv venv
MacOS/Unix: source venv/bin/activate
Windows: venv\scripts\activate

If you are on Windows and you cannot activate the virtual environment, try running Set-ExecutionPolicy Unrestricted -Scope Process in your terminal, ensuring you follow all the prompts, then try this step again.

2. Install the package in your system directory/virtual environment:

pip install -U crossword-puzzle

or, install the package in your home directory if you aren't using a virtual environment:

pip install --user -U crossword-puzzle

3. Install either or both of the optional dependencies (read Dependencies for more information):

pip install pywebview pycairo

4. Initialise the GUI through the entry point:

crossword-ctk

or, run the package manually through the terminal (requires Git):

git clone https://github.com/tomasvana10/crossword_puzzle.git
cd crossword_puzzle
pip install -r requirements.txt

>>> import crossword_puzzle as xp
>>> xp.main()

5. You can deactivate your virtual environment when you are done:

deactivate