Home Install Docs Contribute API Docs Issues Code

Download & Install

pyspread works on Linux, Posix platforms and Windows, on which PyQt6 is available (pyspread <2.3 requires PyQt5). While there have been reports that pyspread can be used on OS X, OS X is currently unsupported (can you help?).

Install pyspread

It is recommended to install pyspread as a package that is provided for your operating system. The table below shows for which operating systems, pyspread is available in which version.

Packaged

If pyspread is unavailable or outdated for your operating system, you can install it using one of the three methods below.

When using pip, a Python virtual environment (venv) is recommended. Some operating systems may nudge your towards this. pipx could be a solution if venv is no option for you.

Furthermore, note that the QtSvg extensions for PyQT are required. For some operating systems, they are packaged separately from PyQt. Please make sure QtSvg is installed on your system before using pip.

With pip

pip install pyspread

From git

It is assumed that python3 and git are installed.

Get sources and enter dir

git clone https://gitlab.com/pyspread/pyspread.git
# or
git clone git@gitlab.com:pyspread/pyspread.git
# then
cd pyspread

Install dependencies and pyspread

pip3 install -r requirements.txt
# or if pip3 is not present
pip install -r requirements.txt
# next
python3 setup.py install

From tarball

It is assumed that python3 and gpg are installed

Download and verify tarball Download the latest pyspread tarball and its gpg signature into the same folder (alternative download location).

gpg --verify pyspread-<version>.tar.gz.sig

Check the output for information if the signature is correct.

Unpack tarball and enter dir

tar xvzf pyspread-<version>.tar.gz
cd pyspread-<version>/

Install dependencies and pyspread

pip3 install -r requirements.txt
# or if pip3 is not present
pip install -r requirements.txt
# next
python3 setup.py install

Launch pyspread

$ pyspread

or after changing directory to the main folder

$ python -m pyspread

or

$ ./pyspread/pyspread.py 

Outdated version (Python 2.x compatible)

The outdated version pyspread v1.1.3 is still available - see install v1.x. Please use it only if you require Python 2.x compatibility. Also note that it is incompatible with Python 3.

© Martin Manns and the pyspread team