<commit_before>========
qtmodern
========

.. image:: https://travis-ci.org/gmarull/qtmodern.svg?branch=master
    :target: https://travis-ci.org/gmarull/qtmodern
    :alt: Travis build

.. image:: https://img.shields.io/pypi/v/qtmodern.svg
    :target: https://pypi.python.org/pypi/qtmodern
    :alt: PyPI Version

``qtmodern`` is a Python package aimed to make PyQt/PySide applications look
better and consistent on multiple platforms. It provides a custom frameless
window and a dark theme. In order to be compatible with multiple Python Qt
wrappers `QtPy <https://github.com/spyder-ide/qtpy>`_ is used. The initial idea
comes from `this project <https://github.com/Jorgen-VikingGod/Qt-Frameless-Window-DarkStyle>`_.

.. raw:: html

    <p align="center">
      <img src="https://github.com/gmarull/qtmodern/blob/master/examples/mainwindow.png" width="50%" alt="Example"/>
    </p>

Installation
------------

The recommended way to install is by using ``pip``, i.e::

    pip install qtmodern

Usage
-----

In order to use ``qtmodern``, simply apply the style you want to your
application and then, create a ``ModernWindow`` enclosing the window you want to
*modernize*::

    ...

    app = QApplication()
    win = YourWindow()

    qtmodern.styles.dark(app)
    mw = qtmodern.windows.ModernWindow(win)
    mw.show()

    ...

<commit_msg>readme: use RST for image, otherwise PyPI won't display it<commit_after>========
qtmodern
========

.. image:: https://travis-ci.org/gmarull/qtmodern.svg?branch=master
    :target: https://travis-ci.org/gmarull/qtmodern
    :alt: Travis build

.. image:: https://img.shields.io/pypi/v/qtmodern.svg
    :target: https://pypi.python.org/pypi/qtmodern
    :alt: PyPI Version

``qtmodern`` is a Python package aimed to make PyQt/PySide applications look
better and consistent on multiple platforms. It provides a custom frameless
window and a dark theme. In order to be compatible with multiple Python Qt
wrappers `QtPy <https://github.com/spyder-ide/qtpy>`_ is used. The initial idea
comes from `this project <https://github.com/Jorgen-VikingGod/Qt-Frameless-Window-DarkStyle>`_.

.. image:: https://github.com/gmarull/qtmodern/blob/master/examples/mainwindow.png
    :width: 450px
    :align: center
    :alt: Example

Installation
------------

The recommended way to install is by using ``pip``, i.e::

    pip install qtmodern

Usage
-----

In order to use ``qtmodern``, simply apply the style you want to your
application and then, create a ``ModernWindow`` enclosing the window you want to
*modernize*::

    ...

    app = QApplication()
    win = YourWindow()

    qtmodern.styles.dark(app)
    mw = qtmodern.windows.ModernWindow(win)
    mw.show()

    ...


{'fraction_non_alphanumeric': 0.14396456256921372, 'fraction_numerical': 0.0018456995201181247, 'mean_word_length': 3.413680781758958, 'pattern_counts': {'":': 0, '<': 10, '<?xml version=': 0, '>': 10, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5575231', 'n_tokens_mistral': 917, 'n_tokens_neox': 848, 'n_words': 254}