Gitlab-Logo.png

We are moving to GitLab

After many years of using Bazaar and Launchpad.net, sadly they are being abandoned by their creators, and so to ensure the longevity of OpenLP, we have decided to move to GitLab.

Keep up to date with the status of our move by checking the Moving_to_GitLab page.

Windows Environment

From OpenLP
Jump to: navigation, search

Installing Python

The recommended version of Python is version 3.6+ for OpenLP 2.9 and 3.0.

NOTE: For now this does not apply to trunk, but only to the webengine-migrate branch. Once that branch is merged into trunk, this will also apply to trunk.

At the time of this writting (~2.9 release) OpenLP is only distributed in a 64-bit build, due to the PyQt package on windows only includes the Webengine module in the 64-bit bundle.

Please ensure that you install VLC(64-bit) if you have Python(64-bit) installed or VLC(32-bit) if you have Python(32-bit) installed.

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

Installing dependencies packages

To install a Python package just type command like:

c:\Python37\scripts\python.exe -m pip install PACKAGE_NAME

For OpenLP 2.9+/Python 3.6+ run:

c:\Python37\scripts\python.exe -m pip install sqlalchemy alembic appdirs chardet beautifulsoup4 lxml Mako mysql-connector-python pytest mock pyodbc psycopg2 pypiwin32 websockets asyncio waitress six webob requests pyopengl qtAwesome PyQt5 pymediainfo pywin32 pysword pyopengl PyQtWebEngine python-vlc

Verify Installation

Once you have completed this, check the install is successful by launching python script in a command prompt:

C:\python37\python OPENLP_SRC\scripts\check_dependencies.py

The output should be similar to the following:

Checking Python version...
  Python >= 3.6 ...                    3.7.2.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
Checking for optional modules...
  mysql.connector (MySQL support)...   OK
  pyodbc (ODBC support)...             OK
  psycopg2 (PostgreSQL support)...     OK
  enchant (spell checker)...           OK
  pysword (import SWORD bibles)...     OK
  uno (LibreOffice/OpenOffice support)...  OK
  jenkins (access jenkins api)...      OK
  launchpadlib (launchpad script support)...  FAIL
  nose2 (testing framework)...         FAIL
  pylint (linter)...                   OK
Checking for Windows specific modules...
  win32com ...                         OK
  win32ui ...                          OK
  pywintypes ...                       OK
  pyodbc ...                           OK
Verifying version of modules...
  PyQt5 >= 5.5 ...                     5.11.3
  Qt5 >= 5.5 ...                       5.11.2
  sqlalchemy >= 0.5 ...                1.2.15
  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: aspell, hunspell, hspell, voikko
  available languages: en_PH, en_US, he