Skip to content

tomasvana10/crossword_puzzle

Repository files navigation

crossword_puzzle

cross-main-pic licence PyPI version Publish to PyPI.org release issues CodeQL Tests

An educational GUI package built with CustomTkinter that allows you to select, configure and generate a crossword to view, interact with and complete in a Flask web application.

Dependencies

Babel customtkinter Flask flask_babel Pillow regex

Installation

Important

Installing crossword_puzzle requires Python 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, then refer to the previous link on how to install pip.

Tip

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

  • 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
  • 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
  • Initialise the GUI through the entry point:
crossword-ctk
  • You can deactivate your virtual environment when you are done:
deactivate

Documentation

Check out the wiki here for information on usage, troubleshooting, FAQ, and more.

Third-party library acknowledgements

  • Flask - Web framework for the crossword web application
  • Babel - l10n functionality and management of message catalogues
  • flask-babel - i18n integration for the Flask web application
  • CustomTkinter - Creation of the main GUI
  • Google.Cloud.Translation.V2 - Translation of locales
  • Pillow - Image processing services
  • regex - Alternative to the standard re module, required for some functionality
  • Zoomooz.js - jQuery library for making webpage elements zoomable
  • gulp.js - Toolkit to help automate the web app's JavaScript transpilation
  • Babel.js - JavaScript transpiler
  • Terser - JavaScript minifier

Other acknowledgements

Gallery

crossword puzzle home
crossword puzzle browser
crossword puzzle game english
crossword puzzle game japanese