aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
blob: 84a4bed1de4c3467d222ec3fdaf138b28583eceb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
======
PySide
======

.. image:: https://pypip.in/wheel/PySide/badge.png
   :target: https://pypi.python.org/pypi/PySide/
   :alt: Wheel Status

.. image:: https://pypip.in/download/PySide/badge.png
   :target: https://pypi.python.org/pypi/PySide/
   :alt: Downloads

.. image:: https://pypip.in/version/PySide/badge.png
   :target: https://pypi.python.org/pypi/PySide/
   :alt: Latest Version

.. image:: https://pypip.in/license/PySide/badge.png
   :target: https://pypi.python.org/pypi/PySide/
   :alt: License

.. image:: https://readthedocs.org/projects/pip/badge/
    :target: https://pyside.readthedocs.org

.. contents:: **Table of Contents** 
   :depth: 2

Introduction
============

PySide is the Python Qt bindings project, providing access the complete Qt 4.8 framework
as well as to generator tools for rapidly generating bindings for any C++ libraries.

The PySide project is developed in the open, with all facilities you'd expect
from any modern OSS project such as all code in a git repository, an open
Bugzilla for reporting bugs, and an open design process. We welcome
any contribution without requiring a transfer of copyright.

The PySide documentation is hosted at `http://pyside.github.io/docs/pyside/
<http://pyside.github.io/docs/pyside/>`_.

Compatibility
=============

PySide requires Python 2.6 or later and Qt 4.6 or better.

.. note::

   Qt 5.x is currently not supported.

Installation
============

Installing prerequisites
------------------------

Install latest ``pip`` distribution: download `get-pip.py
<https://bootstrap.pypa.io/get-pip.py>`_ and run it using
the ``python`` interpreter.

Installing PySide on a Windows System
-------------------------------------

To install PySide on Windows you can choose from the following options:

#. Use pip to install the ``wheel`` binary packages:

   ::

      pip install -U PySide

#. Use setuptools to install the ``egg`` binary packages (deprecated):

   ::

      easy_install -U PySide

.. note::

   Provided binaries are without any other external dependencies.
   All required Qt libraries, development tools and examples are included.


Installing PySide on a Mac OS X System
--------------------------------------

You need to install or build Qt 4.8 first, see the `Qt Project Documentation
<http://qt-project.org/doc/qt-4.8/install-mac.html>`_.

Alternatively you can use `Homebrew <http://brew.sh/>`_ and install Qt with

::

   $ brew install qt

To install PySide on Mac OS X you can choose from the following options:

#. Use pip to install the ``wheel`` binary packages:

   ::

      $ pip install -U PySide


After the installation, the following call must be made manually:

::

   $ pyside_postinstall.py -install


Installing PySide on a Linux System
-----------------------------------

We do not provide binaries for Linux. Please read the build instructions in section
`Building PySide on a Linux System
<http://pyside.readthedocs.org/en/latest/building/linux.html>`_.


Building PySide
===============

- `Building PySide on a Windows System <http://pyside.readthedocs.org/en/latest/building/windows.html>`_.

- `Building PySide on a Mac OS X System <http://pyside.readthedocs.org/en/latest/building/macosx.html>`_.

- `Building PySide on a Linux System <http://pyside.readthedocs.org/en/latest/building/linux.html>`_.


Feedback and getting involved
=============================

- Mailing list: http://lists.qt-project.org/mailman/listinfo/pyside
- Issue tracker: https://bugreports.qt-project.org/browse/PYSIDE
- Code Repository: http://qt.gitorious.org/pyside