Metadata-Version: 2.0
Name: qtilities
Version: 0.6
Summary: Utilities for PyQt5 development
Home-page: https://github.com/pylipp/qtilities
Author: Philipp Metzner
Author-email: beth.aleph@yahoo.de
License: GPLv3
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: PyQt5

# qtilities

A collection of utility programs for PyQt5 development.

## Installation

### From PyPI

    pip install qtilities

### From source

    git clone https://github.com/pylipp/qtilities
    cd qtilities
    make install

## Contents

### `pqp` and `pqpc`

> Python QML Previewer and Client

`pqp` previews QML components and continuously updates while you're editing the source code.

#### Start

Launch an empty previewer:

    > pqp

Launch the previewer displaying one or more components by providing the paths:

    > pqp TextFoo.qml bar/ComboBaz.qml

#### Loading components

Load components by clicking the 'Load' button.

Alternatively you can run the client:

    > pqpc HackWindow.qml

It sends one or more component paths via UDP to port 31415. The previewer `pqp` listens to that port and loads the components.

#### Pausing/resuming preview

`pqp` continuously updates, regardless of changes in the source code or not. If you wish to test user interaction functionality of your component, you can pause the preview by clicking the 'Preview' button.

### `qmltags`

> Basic ctags generator for QML components

`qmltags` generates 'class' ctags for custom QML components.

Run without arguments to recursively parse the current directory and its subdirectories for QML files

    > qmltags

Alternatively, you can provide one or more paths to QML components:

    > qmltags HackWindow.qml screen/*.qml

This assumes that your shell performs file name expansion.

Note that `qmltags` overwrites a `tags` file in the current working directory if it exists.


