Qt for Python/Development Getting Started: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
[toc align_right=&quot;yes&amp;quot; depth=&quot;3&amp;quot;]<br />[[Category:LanguageBindings::PySide]]
[toc align_right="yes" depth="3"]
[[Category:LanguageBindings::PySide]]


= Getting Started with PySide Development =
= Getting Started with PySide Development =
Line 7: Line 8:
== Overview ==
== Overview ==


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 &quot;Qt Project Wiki&amp;quot;:http://wiki.qt.io/Main_Page. For simplicity purposes, much of that wiki page will be summarized here so you can get started faster.
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":http://wiki.qt.io/Main_Page. For simplicity purposes, much of that wiki page will be summarized here so you can get started faster.


== Reporting Bugs ==
== Reporting Bugs ==
Line 29: Line 30:


* '''JIRA account'''
* '''JIRA account'''
*# Go to &quot;bugreports.qt.io&amp;quot;:https://bugreports.qt.io and click on '''Sign Up'''
*# Go to "bugreports.qt.io":https://bugreports.qt.io and click on '''Sign Up'''
*# Fill out the details
*# Fill out the details
* '''Gerrit account'''
* '''Gerrit account'''
*# Go to &quot;codereview.qt.io&amp;quot;:https://codereview.qt.io and click on '''Sign In'''
*# Go to "codereview.qt.io":https://codereview.qt.io and click on '''Sign In'''
*# Login with the username/password you created with JIRA
*# 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.
*#* '''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.
*# Enter your '''full name''' and click '''Save Changes'''
*# Enter your '''full name''' and click '''Save Changes'''
*# Skip the SSH part for now and scroll all the way down and click '''&quot;New Contributor Agreement&amp;quot;'''
*# Skip the SSH part for now and scroll all the way down and click '''"New Contributor Agreement"'''
*## Select '''Individual''' or '''Corporate''', then scroll down and type '''I AGREE''' then '''submit'''
*## Select '''Individual''' or '''Corporate''', then scroll down and type '''I AGREE''' then '''submit'''
*## To check if your agreement was submitted, click on '''Settings''' then '''Agreements'''
*## To check if your agreement was submitted, click on '''Settings''' then '''Agreements'''
Line 44: Line 45:
Please follow the [[Setting-up-Gerrit | Qt Setting up Gerrit]] instructions, particularly the Local Setup and Configuring Git sections. Add a gerrit remote to local project directory with:
Please follow the [[Setting-up-Gerrit | Qt Setting up Gerrit]] instructions, particularly the Local Setup and Configuring Git sections. Add a gerrit remote to local project directory with:


<code><br />$ git remote add gerrit ssh://codereview.qt.io/pyside/&amp;lt;project&amp;gt;<br /></code>
<code>
$ git remote add gerrit ssh://codereview.qt.io/pyside/<project>
</code>


where &lt;project&amp;gt; is either pyside or shiboken.
where <project> is either pyside or shiboken.


=== Pushing changes to Gerrit ===
=== Pushing changes to Gerrit ===
Line 52: Line 55:
After you have committed your changes locally, you can push them to Gerrit like this:
After you have committed your changes locally, you can push them to Gerrit like this:


<code><br /> $ git push gerrit HEAD:refs/for/master
<code>
$ git push gerrit HEAD:refs/for/master

Revision as of 10:01, 25 February 2015

[toc align_right="yes" depth="3"]

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.

Overview

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":http://wiki.qt.io/Main_Page. 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":https://bugreports.qt.io and click on Sign Up
    2. Fill out the details
  • Gerrit account
    1. Go to "codereview.qt.io":https://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: 

$ git remote add gerrit ssh://codereview.qt.io/pyside/<project>

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: 

$ git push gerrit HEAD:refs/for/master
Retrieved from "https://wiki.qt.io/index.php?title=Qt_for_Python/Development_Getting_Started&oldid=6855"