Qt for Python/Development Getting Started

From Qt Wiki
< Qt for Python
Revision as of 16:22, 14 January 2015 by Maintenance script (talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Getting Started with PySide Development

If you’re new to PySide Development, this page is for you! This page is intended to help you get setup and running as a new developer.


The PySide project is supported by the developers who use PySide. This means that anyone who shares an interest in PySide can join the community, participate in its decision making processes, and contribute to PySide development. This page will summarize the key points around how you contribute to PySide, but since PySide follows the same development process as the Qt project, it’s in your best interest to read the Qt Project Wiki [wiki.qt.io]. For simplicity purposes, much of that wiki page will be summarized here so you can get started faster.

Reporting Bugs

Bugs should be reported to the Qt bug tracker at https://bugreports.qt.io/browse/PYSIDE Please include details on how to reproduce your problem and consider contributing a fix for it. Since PySide is developer supported, bugs get fixed when developers contribute fixes for them.

Getting and Building the Source

PySide is split into two packages: Shiboken and PySide. Shiboken is a code generator that is used to generate the C++ code needed by PySide to wrap Qt classes. Shiboken can also be used to wrap other C++ classes. The repositories for both Shiboken and PySide are located on gitorious.org:

Instructions on building are available for Linux, Windows, and OS X. You’ll almost certainly want to use a debug build during development.

Contributing Patches

Because PySide is a Qt project, all patches must be submitted through Qt’s Gerrit code integration system at https://codereview.qt.io All developers need a user account on Gerrit and to agree to the Qt Contributor Agreement. Patches submitted via the bug tracked, mailing list, or pull requests cannot be accepted.

A bug tracker (JIRA) account is needed before a Gerrit account can be created:

  • JIRA account
    1. Go to bugreports.qt.io [bugreports.qt.io] and click on Sign Up
    2. Fill out the details
  • Gerrit account
    1. Go to codereview.qt.io [codereview.qt.io] and click on Sign In
    2. Login with the username/password you created with JIRA
      • NOTE: Gerrit usernames are case-sensitive, but JIRA usernames are not. If you attempt to log into Gerrit with different capitalizations, you will end up with multiple accounts.
    3. Enter your full name and click Save Changes
    4. Skip the SSH part for now and scroll all the way down and click “New Contributor Agreement”
      1. Select Individual or Corporate, then scroll down and type I AGREE then submit
      2. To check if your agreement was submitted, click on Settings then Agreements

Configuring local directories for Gerrit

Please follow the Qt Setting up Gerrit instructions, particularly the Local Setup and Configuring Git sections. Add a gerrit remote to local project directory with:

where <project> is either pyside or shiboken.

Pushing changes to Gerrit

After you have committed your changes locally, you can push them to Gerrit like this: