1. Installing pycrossword
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)
-
-
-
-
-
-
-
-
-
-
-
Git (should be pre-installed on most modern Linux and Mac systems, alternatively install from the
git website)
The latter two (python packages and Git) are not actually required if you opt for the PyPi (pip) installation variant as described below.
Choose one of the two installation options.
1. Clone repo - copy entire source code with version control history
To use 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 switch to the latest stable version, run the following command after the one above:
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
venv pycross
cd pycross
. ./bin/activate
Windows
cd myprojects
venv 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 with pip
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