diff --git a/.gitignore b/.gitignore index 9759ff3d5..b9eca7aad 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,8 @@ /*.pyc /style.rcc /style_pyside_rc.py +./.idea +/.idea/ +/dist/ +/QDarkStyle.egg-info/ +/build/ diff --git a/COPYING b/COPYING new file mode 100644 index 000000000..65c5ca88a --- /dev/null +++ b/COPYING @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 000000000..a5db17972 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,15 @@ +# +# MANIFEST.in +# +# Manifest template for creating the PyLudic source distribution. + +include MANIFEST.in +include setup.py +include COPYING +include README.md +include qdarkstyle/style.qss +include qdarkstyle/style.qrc +include qdarkstyle/rc/*.png + + + diff --git a/README.md b/README.md index b1d1db027..ff170bedb 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,64 @@ QDarkStylesheet ================== -A dark stylesheet for Qt applications. +A dark stylesheet for Qt applications. + + +License +--------- + +This project is licensed under the LGPL v3 + + +Installation +--------------- + +If you are using python, all you have to do is to run setup script or to install it from pypi: + +```bash +pip install qdarkstyle +``` + +or + +```bash +python setup.py install +``` + +If you are using C++, the best way is to download/clone the project and copy +the following files to your application directory: + - qdarkstyle/style.qss + - qdarkstyle/style.qrc + - qdarkstyle/rc (the whole directory) Usage ------------- -- Download/clone the project next to your main executable (or wherever you find it fits well) -- Compile the qrc file for your system and add it to your application. (simply run compile_qrc.py script, it will compile the qrc file for use with Qt (c++), PyQt4 and Pyside). -- Load QDarkStyleSheets/style.qss and apply it on your QApplication instance - -Here is a quick example using PySide: +Here is an example using PySide: ```Python import sys +import qdarkstyle from PySide import QtGui -# import the style resources comiled by compile_rc.py -import style_pyside_rc + # create the application and the main window app = QtGui.QApplication(sys.argv) window = QtGui.QMainWindow() # setup stylesheet -with open("style.qss", 'r') as stylesheet: - app.setStyleSheet(stylesheet.read()) +app.setStyleSheet(qdarkstyle.load_stylesheet()) # run window.show() app.exec_() ``` + +_There is an example included in the example folder. You can run the script without installing qdarkstyle. You +only need to have PySide installed on your system._ + Status: ------------- @@ -67,13 +94,15 @@ What still needs to be done: - QStatusBar - QToolBox + Contact information: -------------------------- - Maintainer: colin.duquesnoy@gmail.com - Homepage: https://github.com/ColinDuquesnoy/QDarkStyleSheet -Screenshots + +Snapshots ------------- I have used this stylesheet for an internal tool at work. Are are a few screenshots: diff --git a/example/example.py b/example/example.py index 6f778c89f..62228f297 100755 --- a/example/example.py +++ b/example/example.py @@ -1,4 +1,14 @@ #!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# QDarkStyle - A dark style sheet for Qt applications +# +# Copyright 2012, 2013 Colin Duquesnoy +# +# This software is released under the LGPLv3 license. +# You should have received a copy of the GNU Lesser General Public License +# along with this program. If not, see . +# """ A simple example of use. @@ -13,20 +23,13 @@ Requirements: the example """ -# standard imports import os import sys - -# PySide imports from PySide import QtGui - -# dark style import: -# make the example runnable without install from os.path import abspath, dirname +# make the example runnable without the need to install sys.path.insert(0, abspath(dirname(abspath(__file__)) + '/..')) import qdarkstyle - -# our ui made in QtDesigner import example_ui diff --git a/qdarkstyle/compile_qrc.py b/qdarkstyle/compile_qrc.py index d5abe9587..740043615 100755 --- a/qdarkstyle/compile_qrc.py +++ b/qdarkstyle/compile_qrc.py @@ -1,10 +1,20 @@ #!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# QDarkStyle - A dark style sheet for Qt applications +# +# Copyright 2012, 2013 Colin Duquesnoy +# +# This software is released under the LGPLv3 license. +# You should have received a copy of the GNU Lesser General Public License +# along with this program. If not, see . +# """ -Utiliy scripts to compile the qrc file. The script will +Utility scripts to compile the qrc file. The script will attempt to compile the qrc file using the following tools: - - rcc - - pyside-rcc - - pyrcc4 + - rcc + - pyside-rcc + - pyrcc4 Delete the compiled files that you don't want to use manually after running this script. @@ -26,4 +36,3 @@ def compile_all(): if __name__ == "__main__": compile_all() - diff --git a/qdarkstyle/style.qss b/qdarkstyle/style.qss index ba7213043..c2b269d3e 100644 --- a/qdarkstyle/style.qss +++ b/qdarkstyle/style.qss @@ -1,3 +1,13 @@ +/* + * QDarkStyle - A dark style sheet for Qt applications + * + * Copyright 2012, 2013 Colin Duquesnoy + * + * This software is released under the LGPLv3 license. + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + */ + QProgressBar:horizontal { border: 1px solid #3A3939; text-align: center; diff --git a/setup.py b/setup.py new file mode 100644 index 000000000..45e282cbf --- /dev/null +++ b/setup.py @@ -0,0 +1,34 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# QDarkStyle - A dark style sheet for Qt applications +# +# Copyright 2012, 2013 Colin Duquesnoy +# +# This software is released under the LGPLv3 license. +# You should have received a copy of the GNU Lesser General Public License +# along with this program. If not, see . +# +""" +QDarkStyle is a darks stylesheet for python qt applications +""" +from setuptools import setup, find_packages + +setup( + name='QDarkStyle', + version='1.0.1', + packages=find_packages(), + package_data={'qdarkstyle': ["*.qss", "*.qrc", "rc/*.png"]}, + url='https://github.com/ColinDuquesnoy/QDarkStyleSheet', + license='LGPLv3', + author='Colin Duquesnoy', + author_email='colin.duquesnoy@gmail.com', + description='A dark stylesheet for pyside/pyqt applications', + long_description=""" + This package provides a dark style sheet for PySide/PyQt applications. + All you have to do is the following:: + + import qdarkstyle + QtGui.QApplication().instance().setStyleSheet(qdarkstyle.load_stylesheet()) + """, +)