Skip to content

wiki
wiki

Windows_Development_Environment

Last edited by Raoul Snyman
Page history

Installing Python.

To get up and running with the development and testing, you'll need to install the Python programming language and several other packages. Python version 3.6 or above is required, currently version 3.7 is recommended.

Download and install the Python Windows Installer from the Python download page.

Installing VLC.

Download and Install VLC for Windows from the VLC download page. You must install the correct version of VLC to match the version of Python you installed. If you installed the 32 bit version of Python then install the 32 bit version of VLC. If you installed the 64 bit version of Python, then you must install the 64 bit version of VLC.

Installing a Virtual Environment.

It is recommended that you install and use the virtual environment for Python. Take a look at the Python Vertual Environment to help decide if you will install the virtual environment.

Installing the Required Addons.

Use pip to install the addin packages that are needed for OpenLP::

pip install sqlalchemy alembic appdirs chardet beautifulsoup4 lxml Mako pymysql pytest pyodbc psycopg2 pypiwin32 websockets asyncio waitress six webob requests pyopengl qtAwesome PyQt5 pymediainfo pywin32 pysword PyQtWebEngine python-vlc pymupdf pyenchant pylint python-jenkins launchpadlib qdarkstyle pyro4 zeroconf

Verify Installation

Open a command prompt, enter your Virtual Environment if you created one and navigate to the openlp directory. The openlp directory should have a scripts directory. Once you are there, type in the following line and press enter.

python scripts\check_dependencies.py

Warning

Only from the top to the Optional packages are mandatory as some packages do not run on all platforms...see uno below as an example of a package that does not run on Windows.

The output should look similar to this:

Checking Python version...
  Python >= 3.6 ...                    3.7.3.final.0
Checking for modules...
  PyQt5 ...                            OK
  PyQt5.QtCore ...                     OK
  PyQt5.QtGui ...                      OK
  PyQt5.QtWidgets ...                  OK
  PyQt5.QtNetwork ...                  OK
  PyQt5.QtOpenGL ...                   OK
  PyQt5.QtSvg ...                      OK
  PyQt5.QtTest ...                     OK
  PyQt5.QtWebEngineWidgets ...         OK
  PyQt5.QtMultimedia ...               OK
  appdirs ...                          OK
  sqlalchemy ...                       OK
  alembic ...                          OK
  lxml ...                             OK
  chardet ...                          OK
  bs4 ...                              OK
  mako ...                             OK
  websockets ...                       OK
  waitress ...                         OK
  webob ...                            OK
  requests ...                         OK
  qtawesome ...                        OK
  pymediainfo ...                      OK
  vlc ...                              OK
  zeroconf ...                         OK
Checking for optional modules...
  qdarkstyle (dark style support)...   OK
  pymysql (MySQL support)...           OK
  pyodbc (ODBC support)...             OK
  psycopg2 (PostgreSQL support)...     OK
  enchant (spell checker)...           OK
  fitz (executable-independent PDF support)...  OK
  pysword (import SWORD bibles)...     OK
  uno (LibreOffice/OpenOffice support)...  FAIL
  jenkins (access jenkins api)...      OK
  launchpadlib (launchpad script support)...  OK
  pytest (testing framework)...        OK
  pylint (linter)...                   OK
Checking for Windows specific modules...
  win32com ...                         OK
  win32ui ...                          OK
  pywintypes ...                       OK
Verifying version of modules...
  PyQt5 >= 5.12 ...                    5.12.2
  Qt5 >= 5.9 ...                       5.12.3
  sqlalchemy >= 0.5 ...                1.3.5
  enchant >= 1.6 ...                   2.0.0
Qt5 image formats...
  read: bmp, cur, gif, icns, ico, jpeg, jpg, pbm, pgm, png, ppm, svg, svgz, tga, tif, tiff, wbmp, webp, xbm, xpm
  write: bmp, cur, icns, ico, jpeg, jpg, pbm, pgm, png, ppm, tif, tiff, wbmp, webp, xbm, xpm`
Enchant (spell checker)...
  available backends: ispell, myspell
  available languages: de_DE, en_AU, en_GB, en_US, fr_FR