Welcome to QDarkStyle’s documentation!

QDarkStyleSheet

Build Status Docs Status Latest PyPI version License: MIT License: CC BY 4.0 Conduct

The most complete dark/light style sheet for Qt applications (Qt4*, Qt5, PySide*, PySide2, PyQt4*, PyQt5, QtPy, PyQtGraph, Qt.Py) for Python 2*/3 and C++.

Check out the complete documentation.

What is new?

Version 3

In the current version 3, qdarkstyle is now working as a theme framework, currently for dark/light themes, keeping styled widgets identical throughout theme colors.

The palette has been redefined and improved (UI/UX) to accept more colors and to be able to implement new themes thanks to the Spyder team collaboration.

The current stable version is using Python 3 (preferable 3.6+) and Qt5 (PyQt5 and PySide 2).

We still preparing the portability to Qt6 since we need changes in QtPy dependency project.

[*] Python 2, as well as Qt4 (PyQt4 and PySide), will not be supported anymore. They are still there as it is, but no back compatibility, fixes, nor features will be implemented.

Version 2

We moved to QtPy to simplify your code in v2.8, thus this is a required dependency now. We included special patches in three main categories: operating system, Qt/binding version, application.

Included in that, lots of widgets’ styles were included/fixed. A Qt application example (Python only) with almost all types of widgets and combinations were included to serve as a portfolio and a checklist for new styles.

We have added SCSS in v2.7, so the palette can be accessed programmatically. Also, many scripts were added to give freedom to developers who want to change the colors of our palette. All images and icons were revised, also creating SVG files for all of them.

In version 2.6 and later, a restructure stylesheet is provided. The palette has only 9 colors. Most widgets are revised and their styles were improved. We also provide a command line (script) to get info that could be used when opening issues. See the image below.

Version 1

First stable release of QDarkStyle.

Installation

Python

From PyPI: Get the latest stable version of qdarkstyle package using pip (preferable):

pip install qdarkstyle

From code: Download/clone the project, go to qdarkstyle folder then:

  • You can use the setup script and pip install.

    pip install .

  • Or, you can use the setup script with Python:

    python setup.py install

C++

  • Download/clone the project and copy the following files to your application directory (keep the existing directory hierarchy). Substitute the theme by the currently available (dark/light) the theme you need to use.

    • qdarkstyle/theme/style.qss
    • qdarkstyle/theme/style.qrc
    • qdarkstyle/theme/rc/ (the whole directory)

  • Add qdarkstyle/theme/style.qrc to your .pro file as follows:

    RESOURCES += qdarkstyle/theme/style.qrc

  • Load the stylesheet:

    QFile f(":qdarkstyle/theme/style.qss");

if (!f.exists())   {
    printf("Unable to set stylesheet, file not found\n");
}
else   {
    f.open(QFile::ReadOnly | QFile::Text);
    QTextStream ts(&f);
    qApp->setStyleSheet(ts.readAll());
}

Note: The “:” in the file name is necessary to define that file as a resource library. For more information see the discussion here.

Usage in applications

If your project already uses QtPy or you need to set it programmatically, it is far more simple

import sys
import qdarkstyle
import os

# set the environment variable to use a specific wrapper
# it can be set to pyqt, pyqt5, pyside or pyside2 (not implemented yet)
# you do not need to use QtPy to set this variable
os.environ['QT_API'] = 'pyqt5'

# import from QtPy instead of doing it directly
# note that QtPy always uses PyQt5 API
from qtpy import QtWidgets

# create the application and the main window
app = QtWidgets.QApplication(sys.argv)
window = QtWidgets.QMainWindow()

# setup stylesheet
# the default system in qdarkstyle uses qtpy environment variable
app.setStyleSheet(qdarkstyle.load_stylesheet())

# run
window.show()
app.exec_()

If you are using PyQt5 directly, see the complete example

import sys
import qdarkstyle
from PyQt5 import QtWidgets

# create the application and the main window
app = QtWidgets.QApplication(sys.argv)
window = QtWidgets.QMainWindow()

# setup stylesheet
app.setStyleSheet(qdarkstyle.load_stylesheet_pyqt5())
# or in new API
app.setStyleSheet(qdarkstyle.load_stylesheet(qt_api='pyqt5'))

# run
window.show()
app.exec_()

Here is an example using PySide2

import sys
import qdarkstyle
from PySide2 import QtWidgets

# create the application and the main window
app = QtWidgets.QApplication(sys.argv)
window = QtWidgets.QMainWindow()

# setup stylesheet
app.setStyleSheet(qdarkstyle.load_stylesheet_pyside2())
# or in new API
app.setStyleSheet(qdarkstyle.load_stylesheet(qt_api='pyside2'))

# run
window.show()
app.exec_()

If you use PyQtGraph, then the code is

import sys
import qdarkstyle
import os

# set the environment variable to use a specific wrapper
# it can be set to PyQt, PyQt5, PySide or PySide2 (not implemented yet)
os.environ['PYQTGRAPH_QT_LIB'] = 'PyQt5'

# import from pyqtgraph instead of doing it directly
# note that PyQtGraph always uses PyQt4 API
from pyqtgraph.Qt import QtGui

# create the application and the main window
app = QtGui.QApplication(sys.argv)
window = QtGui.QMainWindow()

# setup stylesheet
app.setStyleSheet(qdarkstyle.load_stylesheet(qt_api=os.environ['PYQTGRAPH_QT_LIB'])

# run
window.show()
app.exec_()

If you are using Qt.py, which is different from qtpy, you should install qtpy then set both to the same binding.

Usage of example/portfolio

There is an example included in the package. You only need to have PySide2 or PyQt5 is installed on your system.

# dark theme example
$ qdarkstyle.example --palette=dark

# light theme example
$ qdarkstyle.example --palette=light

# no theme/style sheet applied
$ qdarkstyle.example --palette=none

# check all options included
$ qdarkstyle.example --help

Changelog

Please, see CHANGES file.

License

This project is licensed under the MIT license. Images contained in this project is licensed under CC-BY license.

For more information see LICENSE file.

Authors

For more information see AUTHORS file.

Contributing

Most widgets have been styled. If you find a widget that has not been style, just open an issue on the issue tracker or, better, submit a pull request.

If you want to contribute, see CONTRIBUTING file.

Screenshots

Screenshots

Here are a few snapshots comparing the use of QDarkStyle and the default style. Click in the image to zoom.

Containers (no tabs) and Buttons

_images/containers_no_tabs_buttons.png _images/containers_no_tabs_buttons1.png _images/containers_no_tabs_buttons2.png

Containers (tabs) and Displays

_images/containers_tabs_displays.png _images/containers_tabs_displays1.png _images/containers_tabs_displays2.png

Widgets and Inputs (fields)

_images/widgets_inputs_fields.png _images/widgets_inputs_fields1.png _images/widgets_inputs_fields2.png

Views and Inputs (no fields)

_images/views_inputs_no_fields.png _images/views_inputs_no_fields1.png _images/views_inputs_no_fields2.png

Known Issues

Dialog style

Dialogs, e.g. file dialogs, could appear not styled since it inherits from OS theme/style as described in the issue #172. There are some options that can be exploited there.

System icons

Similar to the Dialogs, default icons are inherited from OS but we are planning to create our own set of icons to provide a more uniform UI. See #192.

Contributing

This file describes a path to contribute to this project. Check out our CODE OF CONDUCT.

Bug Reports and Feature Requests

If you have encountered a problem with QDarkStyle or have an idea for a new feature, please submit it to the issue tracker.

Contributing to QDarkStyle

The recommended way for new contributors to submit code to QDarkStyle is to fork the repository on GitHub and then submit a pull request after committing the changes. The pull request will then need to be approved by one of the maintainers before it is merged into the main repository.

  • Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  • Fork the repository on GitHub to start making your changes to the develop branch.
  • Write a test that shows that the bug was fixed or that the feature works as expected, or create a screenshot if you are changing the stylesheet evidencing the changes.
  • Send a pull request and bug the maintainer until it gets merged and published. Make sure to add yourself to AUTHORS and the change(s) to CHANGES.

Getting Started

These are the basic steps needed to start developing on QDarkStyle.

  • Create an account on GitHub

  • Fork the main QDarkStyle repository using the GitHub interface.

  • Clone the forked repository to your machine

    git clone https://github.com/USERNAME/qdarkstyle
cd qdarkstyle

  • Checkout the appropriate branch

    git checkout develop

  • Setup a virtual environment (not essential, but highly recommended).

    • Using virtualenv:

      virtualenv ~/.venv
. ~/.venv/bin/activate
pip install -e .[develop]

    • Using conda (conda-forge):

      conda create -n my-dev-env -c conda-forge python=3.8
conda activate my-dev-env
conda remove --force qdarkstyle # In case you have qdarkstyle installed
conda install -c conda-forge watchdog qtsass
pip install -e .[develop]

  • Create a new working branch. Choose any name you like

    git checkout -b feature-xyz

  • Hands-on

    For tips on working with the code, see the Code Guide.

  • Test, test, test

    Testing is best done through tox, which provides several targets and allows testing against multiple different Python environments:

  • Add you and your changes

    Please add a list item to CHANGES if the fix or feature is not trivial (small doc updates, typo fixes). Please add you as an author to AUTHORS.

  • Add files to commit

    Add files that are part of your changes, remember that each commit must represent a small but functional change. Remember to add CHANGES.rst and AUTHORS.rst too. To add all files changed do:

    git add .

  • Committing changes.

    GitHub recognizes certain phrases that can be used to automatically update the issue tracker, so you can commit like this:

    git commit -m "Add useful new feature that does this, close #42"

git commit -m "Fix returning problem for get_style(), fix #78"

  • Push changes in the branch to your forked repository on GitHub.

    git push origin feature-xyz

  • Submit a pull request (PR).

    Do it from your branch to the respective branch using the GitHub PR interface.

  • Wait for a maintainer to review your changes.

Logging

Inside modules, we provided logging that should be used to inform the user. Please, follow the levels below.

  • debug: for debug information, a highly detailed one, directed to programmers;
  • info: something important for a common user to know;
  • warning: something that should not be a big problem or a decision changed;
  • error: some error, but not capable of stopping program;
  • critical: something that could stop the running program.

Documentation

Documentation is the key to keep all information and necessary instructions to others. We use the reStructured text format (rst) for all docs.

All new functions, classes, files, must be documented with all arguments, returns, exceptions. Without this, it should not pass the tests.

A better example is to see the current files to get the style. We are using Google Format and Sphinx for generating the docs.

Guide to QDarkStyle

Structure of the Example

Now you can use our example to work on the stylesheet. It has all possible widgets provided by Qt - common ones. Feel free to add more to them.

To simplify the structure, there are separated files in qdarkstyle/example/ui folder.

  • dw_buttons.ui: all types of buttons;
  • dw_containers_no_tabs.ui: all types of containers except for tabs;
  • dw_containers_tabs.ui: all containers tabs;
  • dw_displays.ui: all types of displays;
  • dw_inputs_fields.ui: all types of inputs with fields;
  • dw_inputs_no_fields.ui: all types of inputs without fields;
  • dw_views.ui: all types of views;
  • dw_widgets.ui: all types of widgets;
  • mw_menus.ui: main window with all menus and toolbars.

Note: dw stands for dock widget and mw for the main window.

The entire example is built at runtime, in qdarkstyle.example. To see more information about it, see its reference.

Feel free to modify UI files with Qt Designer.

Modifying QSS File

If you are changing the stylesheet, you will need to recompile the QRC files using qdarkstyle.utils.

This generates all resources files (images), style.qrc, _variables.scss, style.qss, and finally style_rc.py for each palette.

Making It Easy

To simplify this process for the developer, if you are changing many things, use the script run_ui_css_edition.py:

python scripts/run_ui_css_edition.py

This creates a loop that restarts the application, processes ui and css files.

For more information about those scripts, see their documentation.

Qt, Stylesheets, Palettes and Icons

Create good palettes with these tools. For example, on Paletton, choose three colors from grayish light (foreground), grayish dark (background) and three more colorful colors (selection). Grayish colors have a little bit of the main color, so it is nice to change it if you change the main color.

As a minimal guide to create new icons (svg) images, we list two main sources.

Main characteristics of SVG images are:

  • Base size: 32px X 32px;
  • Border: 2px space, except continuous lines;
  • Corners and line end’s: rounded;
  • Line: 2px minimum thickness. Complementary thickness using multiples of 2px;
  • Spacing: 4px when needed;
  • Color: #ff0000, red for all images - programmatically changed;
  • Keep only structural changes in images, not colors, e.g, states hover and disabled;
  • Lines and shapes should align with the grid centralized;
  • Names: from basic form to specific, so they keep grouped. Ex.: arrow_left, arrow_up.

Some examples are given below for the horizontal Handle, Minimize, and checked Checkbox.

<th colspan=3>Examples of icons</th>

<td><img src="./images/icon_checkbox_indeterminated.png"/></td>
<td><img src="./images/icon_minimize.png"/></td>
<td><img src="./images/move.png"/></td>

Unit Testing and Fix Preview

It is a good practice, if you are writing functions to QDarkStyle or fixing something related to those functions (not style), that you provide a test for it.

If you are fixing something about style, please, at least, provide an screenshot before and after the fix for comparison. This could be inserted in the issue tracker, as a message. Better than that, use modules provided in test folder to create a GUI test, creating a new file for it.

Check test files to more details. Tests will keep our application stable.

If You Are a Maintainer, Go Ahead to Production

Of course, until you start these steps, make sure the package have passed all tests and checkers before continuing. You must have accounts to both test and official PyPI website below along with be inserted as a maintainer in both.

  1. Install twine

    pip install twine

  2. Generate a distribution (code package and wheel)

    python setup.py sdist bdist_wheel

  3. Check with twine, which also tests README format for PyPI

    twine check dist/*

  4. Try upload in PyPI test page platform before the official

    twine upload --repository-url https://test.pypi.org/legacy/ dist/*

  5. Try to install from test

    pip install --no-deps --index-url https://test.pypi.org/simple/ qdarkstyle

  6. Then, remove it

    pip uninstall qdarkstyle -y

  7. Upload to PyPI official page

    twine upload --repository-url https://upload.pypi.org/legacy/ dist/*

  8. Try to install from official

    pip install qdarkstyle

You can also use the tox environment to produce the release and upload the distribution.

tox -e release

Colors

Color System

The color system is the source of the colors that themes draw from. Each has a range of values from 0 (black #000000) to 150 (white #ffffff). Not all colors are or should be used in every theme, but the scales provide a chance to see the colors in a larger context and makes it easy to switch out colors as desired.

The number assigned to each estimates how light or dark that color is. For parts of an interface that are interactive, have text, or have any other important information, please use colors combinations that have at least a difference of 20 where colors overlap. Depending on the colors, you may need more contrast to create a theme that meets accessibility standards about contrast or color blindness.

Gray

System Name Value Sample
B0 #000000 image1
B10 #19232D image2
B20 #262E38 image3
B30 #37414F image4
B40 #455364 image5
B50 #54687A image6
B60 #60798B image7
B70 #788D9C image8
B80 #9DA9B5 image9
B90 #CBCACA image10
B100 #D9D8D8 image11
B110 #E1E1E1 image12
B120 #EEEEEE image13
B130 #F5F5F5 image14
B140 #FAFAFA image15
B150 #FFFFFF image16

Blue

System Name Value Sample
B0 #000000 image17
B10 #062647 image18
B20 #26486B image19
B30 #375A7F image20
B40 #346792 image21
B50 #1A72BB image22
B60 #057DCE image23
B70 #259AE9 image24
B80 #37AEFE image25
B90 #73C7FF image26
B100 #9FD9FF image27
B110 #C2E3FA image28
B120 #CEEBFF image29
B130 #DAF0FF image30
B140 #F5FBFF image31
B150 #FFFFFF image32

qdarkstyle

qdarkstyle package

The most complete dark/light style sheet for Qt applications (Qt4, Qt5, PySide, PySide2, PyQt4, PyQt5, QtPy, PyQtGraph, Qt.Py) for Python 2/3 and C++.

Python 2, as well as Qt4 (PyQt4 and PySide), will not be supported anymore. They still there as it is, but no back-compatibility, fixes, nor features will be implemented.

We still preparing the portability to Qt6 since we need changes in QtPy dependency project.

Check the documentation to see how to set the desirable theme palette.

This module provides a function to load the stylesheets transparently with the right resources file.

First, start importing our module

import qdarkstyle

Then you can get stylesheet provided by QDarkStyle for various Qt wrappers as shown below

# PySide
dark_stylesheet = qdarkstyle.load_stylesheet_pyside()
# PySide 2
dark_stylesheet = qdarkstyle.load_stylesheet_pyside2()
# PyQt4
dark_stylesheet = qdarkstyle.load_stylesheet_pyqt()
# PyQt5
dark_stylesheet = qdarkstyle.load_stylesheet_pyqt5()

Alternatively, from environment variables provided by QtPy, PyQtGraph, Qt.Py

# QtPy
dark_stylesheet = qdarkstyle.load_stylesheet()
# PyQtGraph
dark_stylesheet = qdarkstyle.load_stylesheet(qt_api=os.environ('PYQTGRAPH_QT_LIB'))
# Qt.Py
dark_stylesheet = qdarkstyle.load_stylesheet(qt_api=Qt.__binding__)

Finally, set your QApplication with it

app.setStyleSheet(dark_stylesheet)

Enjoy!

qdarkstyle._apply_application_patches(QCoreApplication, QPalette, QColor, palette)[source]

Apply application level fixes on the QPalette.

The import names args must be passed here because the import is done inside the load_stylesheet() function, as QtPy is only imported in that moment for setting reasons.

qdarkstyle._apply_binding_patches()[source]

Apply binding-only specific stylesheet patches for the same OS.

Returns:stylesheet string (css).
Return type:str
qdarkstyle._apply_os_patches(palette)[source]

Apply OS-only specific stylesheet pacthes.

Returns:stylesheet string (css).
Return type:str
qdarkstyle._apply_version_patches(qt_version)[source]

Apply version-only specific stylesheet patches for the same binding.

Parameters:qt_version (str) – Qt string version.
Returns:stylesheet string (css).
Return type:str
qdarkstyle._load_stylesheet(qt_api='', palette=None)[source]

Load the stylesheet based on QtPy abstraction layer environment variable.

If the argument is not passed, it uses the current QT_API environment variable to make the imports of Qt bindings. If passed, it sets this variable then make the imports.

Parameters:
  • qt_api (str) – qt binding name to set QT_API environment variable. Default is ‘’. Possible values are pyside, pyside2 pyqt4, pyqt5. Not case sensitive.
  • palette (Palette) – Palette class that inherits from Palette.

Note

  • Note that the variable QT_API is read when first imported. So, pay attention to the import order.
  • If you are using another abstraction layer, i.e PyQtGraph to do imports on Qt things you must set both to use the same Qt binding (PyQt, PySide).
  • OS, binding and binding version number, and application specific patches are applied in this order.
Returns:stylesheet string (css).
Return type:str
qdarkstyle.load_stylesheet(*args, **kwargs)[source]

Load the stylesheet. Takes care of importing the rc module.

Parameters:
  • pyside (bool) – True to load the PySide (or PySide2) rc file, False to load the PyQt4 (or PyQt5) rc file. Default is False.
  • or –
  • qt_api (str) – Qt binding name to set QT_API environment variable. Default is ‘’, i.e PyQt5 the default QtPy binding. Possible values are pyside, pyside2 pyqt4, pyqt5. Not case sensitive.
  • or –
  • palette (Palette) – Class (not instance) that inherits from Palette.
Raises:

TypeError – If arguments do not match: type, keyword name nor quantity.
Returns:

the stylesheet string.
Return type:

str
qdarkstyle.load_stylesheet_from_environment(is_pyqtgraph=False)[source]

Load the stylesheet from QT_API (or PYQTGRAPH_QT_LIB) environment variable.

Parameters:is_pyqtgraph (bool) – True if it is to be set using PYQTGRAPH_QT_LIB.
Raises:KeyError – if PYQTGRAPH_QT_LIB does not exist.
Returns:the stylesheet string.
Return type:str
qdarkstyle.load_stylesheet_pyqt()[source]

Load the stylesheet for use in a PyQt4 application.

Returns:the stylesheet string.
Return type:str
qdarkstyle.load_stylesheet_pyqt5()[source]

Load the stylesheet for use in a PyQt5 application.

Returns:the stylesheet string.
Return type:str
qdarkstyle.load_stylesheet_pyside()[source]

Load the stylesheet for use in a PySide application.

Returns:the stylesheet string.
Return type:str
qdarkstyle.load_stylesheet_pyside2()[source]

Load the stylesheet for use in a PySide2 application.

Returns:the stylesheet string.
Return type:str

Subpackages

qdarkstyle.dark package
Submodules
qdarkstyle.dark.palette module

QDarkStyle default dark palette.

class qdarkstyle.dark.palette.DarkPalette[source]

Bases: qdarkstyle.palette.Palette

Dark palette variables.

COLOR_ACCENT_1 = '#26486B'
COLOR_ACCENT_2 = '#346792'
COLOR_ACCENT_3 = '#1A72BB'
COLOR_ACCENT_4 = '#259AE9'
COLOR_ACCENT_5 = '#37AEFE'
COLOR_BACKGROUND_1 = '#19232D'
COLOR_BACKGROUND_2 = '#293544'
COLOR_BACKGROUND_3 = '#37414F'
COLOR_BACKGROUND_4 = '#455364'
COLOR_BACKGROUND_5 = '#54687A'
COLOR_BACKGROUND_6 = '#60798B'
COLOR_TEXT_1 = '#E0E1E3'
COLOR_TEXT_2 = '#C9CDD0'
COLOR_TEXT_3 = '#ACB1B6'
COLOR_TEXT_4 = '#9DA9B5'
ID = 'dark'
OPACITY_TOOLTIP = 230
qdarkstyle.dark.style_rc module
qdarkstyle.example package

This package contains the application example with all Qt elements.

Submodules
qdarkstyle.example.__main__ module

Example of qdarkstyle use for Python and Qt applications.

This module a main window with every item that could be created with Qt Design (common ones) in the basic states (enabled/disabled), and (checked/unchecked) for those who has this attribute.

Requirements:

  • Python 3
  • QtPy
  • PyQt5 or PyQt4 or PySide2 or PySide
  • PyQtGraph or Qt.Py (if chosen)

To run this example using PyQt5, simple do

python example.py

or

python example.py  --qt_from=pyqt5

Other options for qt_from are: pyqt5, pyside2, pyqt, pyside, qtpy, pyqtgraph, and qt.py. Also, you can run the example without any theme (none), to check for problems.

python example.py  --qt_from=pyqt5 --palette=none

Note

qdarkstyle does not have to be installed to run the example.

qdarkstyle.example.__main__._read_settings(window, reset, QSettingsClass)[source]

Read and set window settings from a file.

qdarkstyle.example.__main__._write_settings(window, QSettingsClass)[source]

Get window settings and write it into a file.

qdarkstyle.example.__main__.create_screenshots(app, window, args)[source]

Save screenshots for different application views and quit.

qdarkstyle.example.__main__.main()[source]

Execute QDarkStyle example.

qdarkstyle.light package
Submodules
qdarkstyle.light.palette module

QDarkStyle default light palette.

class qdarkstyle.light.palette.LightPalette[source]

Bases: qdarkstyle.palette.Palette

Theme variables.

COLOR_ACCENT_1 = '#DAEDFF'
COLOR_ACCENT_2 = '#9FCBFF'
COLOR_ACCENT_3 = '#73C7FF'
COLOR_ACCENT_4 = '#37AEFE'
COLOR_ACCENT_5 = '#259AE9'
COLOR_BACKGROUND_1 = '#FAFAFA'
COLOR_BACKGROUND_2 = '#E0E1E3'
COLOR_BACKGROUND_3 = '#CED1D4'
COLOR_BACKGROUND_4 = '#C9CDD0'
COLOR_BACKGROUND_5 = '#B9BDC1'
COLOR_BACKGROUND_6 = '#ACB1B6'
COLOR_TEXT_1 = '#19232D'
COLOR_TEXT_2 = '#293544'
COLOR_TEXT_3 = '#54687A'
COLOR_TEXT_4 = '#788D9C'
ID = 'light'
OPACITY_TOOLTIP = 230
qdarkstyle.light.style_rc module
qdarkstyle.utils package
Submodules
qdarkstyle.utils.__main__ module
qdarkstyle.utils.images module
qdarkstyle.utils.scss module

Submodules

qdarkstyle.__main__ module
qdarkstyle.__main__.main()[source]

Execute QDarkStyle helper.

qdarkstyle.colorsystem module
class qdarkstyle.colorsystem.Blue[source]

Bases: object

B0 = '#000000'
B10 = '#062647'
B100 = '#9FCBFF'
B110 = '#C2DFFA'
B120 = '#CEE8FF'
B130 = '#DAEDFF'
B140 = '#F5FAFF'
B150 = '##FFFFFF'
B20 = '#26486B'
B30 = '#375A7F'
B40 = '#346792'
B50 = '#1A72BB'
B60 = '#057DCE'
B70 = '#259AE9'
B80 = '#37AEFE'
B90 = '#73C7FF'
class qdarkstyle.colorsystem.Gray[source]

Bases: object

B0 = '#000000'
B10 = '#19232D'
B100 = '#B9BDC1'
B110 = '#C9CDD0'
B120 = '#CED1D4'
B130 = '#E0E1E3'
B140 = '#FAFAFA'
B150 = '#FFFFFF'
B20 = '#293544'
B30 = '#37414F'
B40 = '#455364'
B50 = '#54687A'
B60 = '#60798B'
B70 = '#788D9C'
B80 = '#9DA9B5'
B90 = '#ACB1B6'
qdarkstyle.palette module

Base palette mixin.

class qdarkstyle.palette.Palette[source]

Bases: object

BORDER_1 = '1px solid $COLOR_BACKGROUND_1'
BORDER_2 = '1px solid $COLOR_BACKGROUND_4'
BORDER_3 = '1px solid $COLOR_BACKGROUND_6'
BORDER_SELECTION_1 = '1px solid $COLOR_ACCENT_1'
BORDER_SELECTION_2 = '1px solid $COLOR_ACCENT_2'
BORDER_SELECTION_3 = '1px solid $COLOR_ACCENT_3'
COLOR_ACCENT_1 = ''
COLOR_ACCENT_2 = ''
COLOR_ACCENT_3 = ''
COLOR_ACCENT_4 = ''
COLOR_ACCENT_5 = ''
COLOR_BACKGROUND_1 = ''
COLOR_BACKGROUND_2 = ''
COLOR_BACKGROUND_3 = ''
COLOR_BACKGROUND_4 = ''
COLOR_BACKGROUND_5 = ''
COLOR_BACKGROUND_6 = ''
COLOR_TEXT_1 = ''
COLOR_TEXT_2 = ''
COLOR_TEXT_3 = ''
COLOR_TEXT_4 = ''
ID = None
OPACITY_TOOLTIP = 0
PATH_RESOURCES = "':/qss_icons'"
SIZE_BORDER_RADIUS = '4px'
W_STATUS_BAR_BACKGROUND_COLOR = ''
classmethod color_palette()[source]

Return the ordered colored palette dictionary.

classmethod to_dict(colors_only=False)[source]

Convert variables to dictionary.

scripts

run_ui_css_edition module

Changelog

  • 3.1:
    • Fixes generating resources
    • Correct spelling mistakes
    • Refactoring functions from qdarkstyle.utils
    • Include prefix of palette.ID for qrc, qss, _rc files, keep working on C++ #273
    • Fix global variables issue #298
    • Include data files when installing package #299
  • 3.0.3:
    • Temporary fix for expanded combo box in Qt 5.15, fixes #282, #285, MR #288
    • Fix generating assets in Posix
    • Fix tristate value for checkbox #275
    • Minor fixes and improvements
  • 3.0.2:
    • Enable the use of setTabColor and add example, fixes #212
    • Update description to inform about Python 2 and Qt4 unsupported versions
    • Add missing examples #251
  • 3.0.1:
    • Enhancement of state of active/non-active items in views #209
    • Update manifest to include UI files
  • 3.0.0:
    • New structure to create different palettes #268, #164
    • New light palette #240, #268
    • Improved dark palette #252, #266, #264, #265, #248
    • Improved tool buttons #260
    • Improved tabs #270, #271, #267
    • Improved combo boxes #263
    • Improved close/float sizes os-dependent #267
    • Fix checkbox problems #200, #259, #239
    • Fix indicators’ colors in menus and tables #242
    • Fix dock widget tab hover #243
    • Workaround for menus with indicators and icons #214
    • Update to be compatible with Qt 5.[12,13,14,15]
  • 2.8.1:
    • Fix rst file formats and links #229
    • Add .gitattributes for generated and documentation files
    • Add more complete tox and Travis envs with many checks
    • Fix removing message format argument
    • Fix QGroupBox small indicator size #218
    • Fix QGroupBox incorrect indicator icon when unfocused #219
    • Fix QDateTimeEdit incorrect drop-down arrow icon #220
    • Fix documentation
  • 2.8:
    • Fix tooltip giant rectangle #174
    • Fix QTextEdit without borders inside frame #188
    • Fix PyQt5 issues on dropdown #191
    • Fix combo box with icons #169
    • Fix QToolbBar vertical handle #210
    • Fix pane tab label cropped on activation #199
    • Enhance vertical/horizontal lines #184
    • Enhance tool button size and spacing #181, #183, #202
    • Enhance buttons and inputs with focus, blue border #194, #211
    • Enhance QSplitter #207
    • Removed QStatusBar vertical lines #205
  • 2.7:
    • Remove utils from import in qdarkstyle, #170
    • Fix border colors in tool button #176
    • Fix scroll area and stacked with 2px padding, #159
    • Fix background submenu color, #179
    • Fix extra border aside header’s arrow indicator, #180
    • Fix menu right arrow indicator
    • Fix slide bars colors, #150
    • Fix QLabels problems, #163, #139
    • Fix problems with example settings using PySide2 and –no_dark #167
    • Provide SVG files for all images, standard names, and sizes, fix images, #149
    • Improve images and add high-resolution images, #140
    • Improve docs
    • Add check to scripts for generating images, #137
    • Fix tox and Travis scripts #76
    • Provide docs in RTD, part of #160
    • Add helpdev dependency for reports and checks, #147
    • Update authors and maintainers
  • 2.6.8:
    • Fix double border in QtabWidget for pyqt5
    • Fix widgets border in QTabWidget as QLabel #141, #123, #126
    • Fix QTab scroller buttons background #136
    • Update color from images, fix #127
    • Add retina resolution @2x, fix #140
    • Intermediate version before merge PR #142 adding scripts
  • 2.6.7:
    • Fix combobox indicator and padding #132
    • Fix PyQtGraph plot axes covered by padding #134
    • Update authors
  • 2.6.6:
    • Fix tabbed borderless frames and add more examples, #123, #126
    • Add feedback to pressed buttons, #133
    • Change future warning to pending deprecation for developers, #125 in v2.x
    • Fix hover in qtabwidget, #128
  • 2.6.5:
    • Fix borderless widgets inside QTabWidget, #123
    • Fix palette table inside CSS file, header using the last column
    • Tested on Python 27, 34, 36, 37
  • 2.6.4:
    • Python 2.7 compatibility, #121
    • Fix MANIFEST
  • 2.6.3:
    • Palette color enhances, better contrast, contribute to #118
    • Fixes Qslider background
    • Better colors and format for tab and toolbox, contribute to #118
  • 2.6.2:
    • Enhance command link button
    • Enhance tab colors and spacing, closes #118
    • Start using tox, helping partially #77
    • Fix example and other scripts issues
  • 2.6.1:
    • Fix and improve QSplitter and separators from toolbar and windows #115
    • Fix README version screenshots and update them
    • Add reset function into an example to reset GUI settings, after you mess up with
  • 2.6:
    • Many other enhancements and fix #103, #111, #106
    • Fix tab disabled, background and color
    • Enhance tab selection
    • Enhance spacing (padding and margin)
    • Enhance table, list, tree and combo box selection
    • Fix slider disabled and enhance size
    • Fix the wrong upload of style.qss - sorry
    • Fix almost all widgets backgrounds and other not previously covered widgets with new style
    • New palette color, almost whole new qss file, simplifies configuration, partially #112, #101, #109,
    • Add changes made by other people in the new style - merge does not work there #93, #92, #102
    • Update README with Qt.py and PySide 2 information #110, #107, #83
    • Update init info
    • Improve scripts for processing ui and qrc
    • Add main and setup entry, to access the function directly
    • Add function to get information about bindings and abstraction layers for debugging and/or issue tracker
    • PySide 2 support
    • Improve menu indicator position on QPushButton, #102
  • 2.5.4
    • Fix indicator image of checkable QGroupBox for a check/uncheck states, #93
    • Fix the wrong comma position, #95
    • Added image for the missing QTreeView/QListView undetermined state, fix #92
  • 2.5.3
    • Add future warning and pending deprecation for 3.0 version preparation #89
    • Add ISSUE_TEMPLATE to ask for default information on the issue tracker
  • 2.5.2:
    • Modularize files from example/ui to simplify edition (developers)
    • Add scripts to process files and run examples more easily (developers)
    • Better documentation (developers)
    • Add CONTRIBUTE, CODE_OF_CONDUCT, and PRODUCTION files
    • Lint markdown to standardize files
    • Fix and add more information in C++ example
  • 2.5.1:
    • Fix Travis files, needs more improvement #74
    • Improve modules description
    • Update setup.py, remove the license
    • Update and improve README, CHANGES and AUTHORS
  • 2.5:
    • Add a new complete example with new files
    • Add new screenshots for new example
    • Update Travis files
    • Add support to the example of QtPy and PyQtGraph
    • Move scripts for compiling to script folder
    • Update README, CHANGES
  • 2.4:
    • Add function to get Qt information from environment variable #69, #70, #73
    • Add CC-BY license for images and transfer COPYING to LICENSE file #68
    • Fix tabs style - selected tab color and shift #59, #72
    • Restructure README creating AUTHORS, CHANGES, and LICENSE #71
  • 2.3.1:
    • Improve checkbox color (use accent color used in other widgets) and

    darken view hover/selected colors to play nicer with other widget colors - Shift to the right of the first tab - Update license year - Update README (fix snapshots links and formatting) - Removed QLineEdit top/bottom padding which cut off a text while editing QListView items

  • 2.3.0:
    • Add support for QDateEdit
  • 2.2.2:
    • Add hover to the unselected item in QListView/QTreeView
    • Fixes for vertical QToolBar, QToolBar Extend Button & QTabWidget’s Pane Misalignment
    • Fixed consistency of QTabBar depending on the position
  • 2.2.1:
    • Remove border of status bar widgets
  • 2.2:
    • Major update of the color scheme based on the Breeze Dark theme of KDE 5
    • Fix issues #29, #30, #31, #32 and #35
  • 2.1:
    • Add style for QPushButton:checked
    • Improve QCheckBox and QRadioButton style
    • Add style for QMenu::right-arrow
  • 2.0:
    • Improve the stylesheet to make it look a bit more modern (see pull request #25)
  • 1.16:
    • Fix QGroupBox title padding (see issue #20)
  • 1.15:
    • Improve tristate checkbox graphics: the undetermined state is now represented by a dash
  • 1.14:
    • Add support for tristate checkboxes and for vertical and horizontal lines
  • 1.13:
    • Fix issue with horizontal scrollbar arrows, left and right were inversed.
  • 1.12:
    • Fix the minimum size of input widgets (see issue #14)
  • 1.11:
    • Fix QDockWidget title position on Mac.
    • Add QStatusBar support
    • Improve QToolButton especially the MenuButtonPopup and InstantPopup modes
  • 1.10:
    • Add PyQt5 support
    • Fix bug #12 (dock widget title not dark on OSX. Note that this reopens issue #8 for MAC users)
  • 1.9:
    • Improve QTabBar consistency and make selected tabs more distinctive
  • 1.8:
    • Add support for QToolBox
    • Fix issue with grid line in QTableView if there is only ONE row/column
  • 1.7:
    • Fix the appearance of bottom tab bars (invert gradient)
    • Improve QTableView: add grid line and fix section borders
    • Fix bug #7: bug when resizing QTableView
    • Fix bug #8: text validation not working on QDockWidget
  • 1.6:
    • Improve QToolButton style
    • Add support for InstantPopup and MenuButtonPopup
    • Improve QMenu style (better spacing with icons)
    • Add __version__ to Python package.
  • 1.5:
    • Improve QTabBar style: now works with all tab bar positions (North, South, West and East)
    • Fix bug #6: hide QTabBar base to avoid strange lines at the base of the tab bar.
  • 1.4:
    • Add style.qss to qrc file, this fix issues with cx_freeze
  • 1.3:
    • Remove outline on button, checkbox and radio button
    • Add support for closable tabs
    • Better disabled buttons
    • Fix QTextEdit background color to match the color of QPlainTextEdit

    and QLineEdit - Better hover/selected states for QTreeView and QListView - Add QHeaderView support

  • 1.2:
    • Improve QTableView support
  • 1.1:
    • Switch to MIT license
    • Add python 3 support
  • 1.0:
    • First public release (LGPL v2)

Authors

Maintainer(s)

These people were/are maintainers of this project.

Contributor(s)

These people contribute to bug fixes, improvements and so on. Please, insert your information after the last one.

  • Year - Name - <contact> - contribution.
  • 2018 - mowoolli - bug fixes.
  • 2018 - Xingyun Wu - xingyun.wu@foxmail.com - bug fixes.
  • 2018 - KcHNST - bug fixes.
  • 2019 - goanpeca - bug fixes, improvements, features.
  • 2020 - tsilia - bug fixes.
  • 2021 - isabela-pf - new palette design.
  • 2021 - juanis2112 - improvements.
  • 2021 - ccordoba12 - mainteiner/improvements.
  • 2021 - Julian Gilbey jdg@debian.org - bug fixes.

And all people that reported bugs, thank you all!

License

The MIT License (MIT) - Code

Copyright (c) 2013-2019 Colin Duquesnoy

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Creative Commons Attribution International 4.0 - Images

QDarkStyle (c) 2013-2019 Colin Duquesnoy QDarkStyle (c) 2019-2019 Daniel Cosmo Pizetta

Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.

Using Creative Commons Public Licenses

Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.

  • Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
  • Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.

Creative Commons Attribution 4.0 International Public License

By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License (“Public License”). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.

Section 1 – Definitions

  1. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
  2. Adapter’s License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
  3. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
  4. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
  5. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
  6. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
  7. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
  8. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
  9. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
  10. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
  11. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.

Section 2 – Scope

  1. License grant.

  1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:

    A. reproduce and Share the Licensed Material, in whole or in part; and

    1. produce, reproduce, and Share Adapted Material.

  2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.

  3. Term. The term of this Public License is specified in Section 6(a).

  4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.

  5. Downstream recipients.

    A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.

    B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.

  6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).

  1. Other rights.
  1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
  2. Patent and trademark rights are not licensed under this Public License.
  3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.

Section 3 – License Conditions

Your exercise of the Licensed Rights is expressly made subject to the following conditions.

  1. Attribution.

  1. If You Share the Licensed Material (including in modified form), You must:

    A. retain the following if it is supplied by the Licensor with the Licensed Material:

    1. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
    2. a copyright notice;
    3. a notice that refers to this Public License;
    4. a notice that refers to the disclaimer of warranties;
    5. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;

    B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and

    C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.

  2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.

  3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.

  4. If You Share Adapted Material You produce, the Adapter’s License You apply must not prevent recipients of the Adapted Material from complying with this Public License.

Section 4 – Sui Generis Database Rights

Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:

  1. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
  2. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
  3. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.

For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.

Section 5 – Disclaimer of Warranties and Limitation of Liability

  1. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
  2. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
  3. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.

Section 6 – Term and Termination

  1. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
  2. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
  1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
  2. upon express reinstatement by the Licensor.

For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.

  1. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
  2. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.

Section 7 – Other Terms and Conditions

  1. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
  2. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.

Section 8 – Interpretation

  1. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.

  2. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.

  3. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.

  4. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.

    Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.

    Creative Commons may be contacted at creativecommons.org

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others’ private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at daniel.pizetta@usp.br. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

Indices and tables