|
| 1 | +PythonQt |
| 2 | +======== |
| 3 | + |
| 4 | +Overview |
| 5 | +-------- |
| 6 | + |
| 7 | +PythonQt is a dynamic [Python](http://www.python.org) binding for [Qt](http://qt.nokia.com). |
| 8 | +It offers an easy way to embed the Python scripting language into |
| 9 | +your Qt applications. It makes heavy use of the QMetaObject system and thus requires Qt4.x. |
| 10 | + |
| 11 | +This project is a fork of the [official PythonQt](http://pythonqt.sourceforge.net/) repository |
| 12 | +hosted on sourceforge. |
| 13 | + |
| 14 | +It serves as *staging area* to contain patches that will then be contributed back to the |
| 15 | +official repository. |
| 16 | + |
| 17 | +Prerequisites |
| 18 | +------------- |
| 19 | + |
| 20 | +* CMake 2.8.x |
| 21 | +* Qt 4.6.2 or above |
| 22 | + |
| 23 | +Build instructions |
| 24 | +------------------ |
| 25 | + |
| 26 | +By default, the `patched-2` version will be checked out. |
| 27 | + |
| 28 | +``` |
| 29 | +git clone git://github.com/commontk/PythonQt.git |
| 30 | +mkdir PythonQt-build |
| 31 | +cd PythonQt-build |
| 32 | +cmake -DQT_QMAKE_EXECUTABLE:FILEPATH=/path/to/qmake ../PythonQt |
| 33 | +make |
| 34 | +``` |
| 35 | + |
| 36 | +Additional configure options are: |
| 37 | + |
| 38 | +* `CMAKE_BUILD_TYPE`: Debug, Release, RelWithDebInfo or MinSizeRel |
| 39 | +* `PythonQt_DEBUG`: Enable/Disable PythonQt debug output |
| 40 | +* `PythonQt_Wrap_Qt<componentname>`: Build PythonQt wrapper associated with `<componentname>`. Possible `<componentname>` are `gui`, `network`, `opengl`, `sql`, `uitools`, `webkit`, `xml`, `xmlpatterns`. |
| 41 | + |
| 42 | +Available branches |
| 43 | +------------------ |
| 44 | + |
| 45 | +This repository contains three branches: |
| 46 | + |
| 47 | +### patched-2 |
| 48 | + |
| 49 | +* Based on [r228](http://pythonqt.svn.sourceforge.net/viewvc/pythonqt?view=revision&revision=228) |
| 50 | +* List of features: |
| 51 | + * At configuration time, detect the Qt version used and seamlessly compile the appropriate wrappers (Qt 4.8, 4.7 or 4.6). |
| 52 | + * Add method allowing to know if a python error occurred: [5935f29](https://github.com/commontk/PythonQt/commit/5935f29978deed892a13ddef02cb14c205c6124d) |
| 53 | + * Fix compilation issue on VS2010 when PythonQt Debug build against python Release: [7e1e07f](https://github.com/commontk/PythonQt/commit/7e1e07f34b2420e420e2858e5ea9a49fe1e0d235) |
| 54 | +* Backported: |
| 55 | + * Most of the [change specific to](https://github.com/commontk/PythonQt/compare/svn-mirror...patched) `patched` branch have been backported upstream: [r200](http://pythonqt.svn.sourceforge.net/viewvc/pythonqt?view=revision&revision=200), [r201](http://pythonqt.svn.sourceforge.net/viewvc/pythonqt?view=revision&revision=201), [r202](http://pythonqt.svn.sourceforge.net/viewvc/pythonqt?view=revision&revision=202), [r203](http://pythonqt.svn.sourceforge.net/viewvc/pythonqt?view=revision&revision=203), [r204](http://pythonqt.svn.sourceforge.net/viewvc/pythonqt?view=revision&revision=204) |
| 56 | + * CMake option `PYTHONQT_USE_VTK` has been removed ([r205](http://pythonqt.svn.sourceforge.net/viewvc/pythonqt?view=revision&revision=205)), the foreign wrapper mechanism should be used: [r206](http://pythonqt.svn.sourceforge.net/viewvc/pythonqt?view=revision&revision=206) |
| 57 | + |
| 58 | +### patched |
| 59 | + |
| 60 | +* Based on [r193](http://pythonqt.svn.sourceforge.net/viewvc/pythonqt?view=revision&revision=193) |
| 61 | +* List of features: |
| 62 | + * CMake'ified PythonQt project |
| 63 | + * CMake'ified PythonQt/generator project |
| 64 | + * Add `dPython.h` file, it provides the ability to link against release python with a debug build of your project. |
| 65 | + * Option `PYTHONQT_USE_VTK` CMake option allowing to teach PythonQt how to deal with `vtkObject` |
| 66 | + * Stdin can optionally be redirected to a custom callback |
| 67 | + * [More details](https://github.com/commontk/PythonQt/compare/svn-mirror...patched) |
| 68 | + |
| 69 | +### svn-mirror |
| 70 | + |
| 71 | +* SVN history imported using `git-svn` |
| 72 | + |
| 73 | +Contributing |
| 74 | +------------ |
| 75 | + |
| 76 | +Once you've made your great commits: |
| 77 | + |
| 78 | +1. [Fork][fk] PythonQt |
| 79 | +2. Create a topic branch - `git checkout -b my_branch` |
| 80 | +3. Push to your branch - `git push origin my_branch` |
| 81 | +4. Create an [Issue][is] with a link to your branch |
| 82 | +5. That's it! |
| 83 | + |
| 84 | + |
| 85 | +Meta |
| 86 | +---- |
| 87 | + |
| 88 | +* Code: `git clone git://github.com/commontk/PythonQt.git` |
| 89 | +* Home: <http://pythonqt.sourceforge.net/> |
| 90 | +* Bugs: <http://github.com/commontk/PythonQt/issues> |
| 91 | + |
| 92 | +License |
| 93 | +------- |
| 94 | + |
| 95 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 96 | +you may not use this file except in compliance with the License. |
| 97 | +You may obtain a copy of the License at |
| 98 | + |
| 99 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 100 | + |
| 101 | +Unless required by applicable law or agreed to in writing, software |
| 102 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 103 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 104 | +See the License for the specific language governing permissions and |
| 105 | +limitations under the License. |
| 106 | + |
| 107 | +[fk]: http://help.github.com/forking/ |
| 108 | +[is]: http://github.com/jcfr/qJobManager/issues |
| 109 | + |
0 commit comments