Skip to content

wiki
wiki

Getting_Started

Last edited by Raoul Snyman
Page history

Mandatory Requirements

If you are interested in contributing to OpenLP at all, including just bug fixes, these are all mandatory requirements. If you just want to look at the code, it is highly recommended that you join the developers in IRC.

Learn How We Do Things (mandatory)

All open source projects have their own way of doing things, and OpenLP is no different. We have standards around naming conventions, syntax and what text in various parts of the GUI should be like. We also have our own development workflow.

Coding and String Standards

Go and read the Coding Standards and the String Standards. If your code and your strings don't conform to the standards, then your merge proposals will be rejected and you may have to rewrite your code.

Development Workflow

We have our own unique workflow in OpenLP. If you're keen to help out, you'll need to learn our development workflow.

Get your development environment up and running

OpenLP is written in Python 3 and Qt5, so you'll need to install Python 3 (3.4+), Qt5, and the PyQt5 Python bindings for Qt5. PyCharm is a great Python IDE with support for PyQt5 which most of the developers use. There is a community edition available for free. Developers who have proven their commitment are entitled to a license for the professional edition (decided by the core developers). You'll also need a Bazaar client in order to check out the latest code. Read more detailed instructions on the following pages:

Firewall access

If you are behind a firewall with the bazaar port blocked, and you only want to download the code rather than push it, then you can check out the code using http. (However when you wish to submit changes you will need full access to bzr.)

bzr checkout http://bazaar.launchpad.net/~openlp-core/openlp/trunk ~/openlp/trunk

Notes

  1. If you get an invalid public key error when using bzr on Windows then make sure you have the BZR_SSH environment variable set: set BZR_SSH=paramiko
  2. If you get permission denied errors because bzr is trying to create a .ssh directory under the administrator's account when you are a normal user then check the %HOME% environment variable for correctness and remove if incorrect - it's not a standard environment variable so applications trying to depend on it are clearly insane.