pycrossword - the Python Crossword Puzzle Generator and Editor
Project description
pycrossword - the Python Crossword Puzzle Generator and Editor
pycrossword is a pure-Python implementation of a crossword puzzle generator and editor.
Download
pycrossword source code and documentation are hosted on Github
The python package is available from PyPi
Features:
- full-fledged Qt 5 based GUI
- cross-platform implementation
- multilingual interface
- fully Unicode-based
- open, save, restore, export, and import crossword puzzles
- powerful word sources: SQLite database / CSV (plaintext) / raw python list
- unlimited undo / redo history
- customizable word blacklisting
- crossword generation (from word sources)
- supports common puzzle file formats: XPF, IPUZ and raw text grid
- easily load, edit and save word clues
- flexible GUI settings: zoom, colors, fonts, grid settings, clues table look & feel, etc.
- import & export configuration presets (JSON-based files)
- auto app updating / new release checking from Github / PyPI
- lookup word definition in an online dictionary and Google
- manual editing of individual words and suggestions from word sources
- comfortable navigation in GUI (hotkeys, keystrokes, mouse)
- multi-character editing
- extensive grid editing (row / column / cell manipulation, block duplication etc.)
- context menus
- hi-res printing to PDF or printer with customizable page / element layout
- export crossword to image (jpg, png, tiff) / PDF / SVG with customizable resolution and other settings
- store crosswords in cloud and share them in social networks (Twitter, Facebook, Instagram etc.)
- view user-friendly stats on current crossword in chart
- inbuilt web browser and Python code editor
- app extension through external and custom plugins (Python API included)
- comprehensive Doxygen-generated API reference and rich help documentation
Installation
Requirements
You must have the following applications / packages installed in your system:
- Python 3.7+ (the app was written and tested with Python 3.7.4 and 3.8.0)
- Python packages:
- pip
- PyQt5>=5.14
- PyQtWebEngine>=5.14
- QScintilla>=2.11
- jedi>=0.16
- yapsy>=1.12
- requests
- numpy
- pandas
- altair
- Git (should be pre-installed on most modern Linux and Mac systems, alternatively install from the git website)
The latter two (packages and Git) are not actually required if you opt for the PyPi (pip) installation variant as described below.
Installation options
Choose one of the two installation options.
1. Clone repo - copy entire source code with version control history
To get the latest (non-stable) version, run:
git clone https://github.com/S0mbre/crossword.git .
This will checkout to the master branch which tracks all recent changes, some of which may not be yet merged into a release version.
To get the latest stable version, run:
git clone https://github.com/S0mbre/crossword.git .
git reset --hard latest
This will checkout to the branch pointed at by the latest tag which will always be the latest stable release.
Install the required packages
I recommend (as many do) installing packages into python's virtual environment using virtualenv or the inbuilt venv:
Create a new virtual environment:
Linux / Mac
cd myprojects
virtualenv pycross
cd pycross
. ./bin/activate
Windows
cd myprojects
virtualenv pycross
cd pycross
scripts\activate.bat
This step is, of course, optional. You can skip it if you don't want to use virtual environments for some reason or other.
Then just run:
cd crossword
python -m pip install -r requirements.txt
If you're using a virtual environment, you can deactivate it after closing the app with deactivate
.
2. Install from PyPi
Create your virtual environment as described above (which is again optional). Then use pip to download and install pycrossword (together with the required additional packages):
pip install --upgrade pycrossword
Usage
Run pycross.sh
on Linux/Mac (remember to do chmod +x pycross.sh
first) or pycross.bat
on Windows to launch the pycrossword UI app.
Alternativaly, you can register the pycrossword file associations at initial run (go to Settings > Common > Register file associations). After that, you can launch the app by double-clicking crossword files (like *.xpf or *.ipuz) or settings files (*.pxjson)
See User Guide for detailed usage.
Roadmap
See roadmap.txt for future plans!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pycrossword-0.4.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ec7b236778d6c61e23fdb30a64ac53ad8653372949744267b405ee52a801191 |
|
MD5 | 6d2061c54ea495fa98519ff55f596d52 |
|
BLAKE2b-256 | 2f6d4bc9f9e444d5adc8837766c69ca12537f1b45e78dfe490c16537e8bed3d6 |