Installation

Warning

This wiki is outdated. Please visit the official documentation instead. Thank you.

Installation

Important

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

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

Linux and MacOS users: 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

Windows users: If 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 xpuz

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

pip install --user xpuz

3. Install pycairo if you want to make PDFs from your generated crosswords (read Dependencies for more information):

pip install pycairo

4. Initialise the GUI through the entry point:

xpuz-ctk

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

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

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

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

deactivate

Updating

1. Activate your virtual environment if you are using one.

2. Update the package:

pip install -U xpuz