qt-dev-helper


Nameqt-dev-helper JSON
Version 0.0.4 PyPI version JSON
download
home_pagehttps://github.com/s-weigand/qt-dev-helper
SummaryTool to help developing Qt applications
upload_time2023-07-08 01:14:47
maintainer
docs_urlNone
authorSebastian Weigand
requires_python>=3.8
licenseApache Software License 2.0
keywords qt_dev_helper
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Qt Dev Helper

[![PyPi Version](https://img.shields.io/pypi/v/qt_dev_helper.svg)](https://pypi.org/project/qt-dev-helper/)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/qt_dev_helper.svg)](https://pypi.org/project/qt-dev-helper/)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/qt-dev-helper.svg)](https://anaconda.org/conda-forge/qt-dev-helper)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Actions Status](https://github.com/s-weigand/qt-dev-helper/workflows/Tests/badge.svg)](https://github.com/s-weigand/qt-dev-helper/actions)
[![Documentation Status](https://readthedocs.org/projects/qt-dev-helper/badge/?version=latest)](https://qt-dev-helper.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/s-weigand/qt-dev-helper/branch/main/graph/badge.svg)](https://codecov.io/gh/s-weigand/qt-dev-helper)
[![Documentation Coverage](https://raw.githubusercontent.com/s-weigand/qt-dev-helper/main/docs/_static/interrogate_badge.svg)](https://github.com/s-weigand/qt-dev-helper)
[![Code style Python: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![All Contributors](https://img.shields.io/github/all-contributors/s-weigand/qt-dev-helper)](#contributors)

Toolbox to help develop Qt applications, improving the usability of the existing tooling.

## Installation

```console
pip install qt-dev-helper
```

OR

```console
conda install -c conda-forge qt-dev-helper
```

## Features

- Usable as Library and/or CLI tool
- Compatible with [PEP517](https://peps.python.org/pep-0517/) build system
  ([see test case](https://github.com/s-weigand/qt-dev-helper/blob/main/tests/data/pyproject.toml))
- CLI auto completion
- Project wide configuration in `pyproject.toml`
- Recursive asset compiler for Qt projects (using `uic` and `rcc`):
  - `*.ui` -> `*.py`
  - `*.qrc` -> `*.py`
  - `*.ui` -> `*.h`
  - `*.qrc` -> `*.h`
  - `*.scss` -> `*.qss`
- Support for multiple Qt tooling suppliers
  - `PySide6-Essentials`
  - `qt6-applications`
  - `qt5-applications`
- Ability to open all files in a folder in QtDesigner

## Planned features

- Stand alone executable for each release (Windows)
- File watch mode
- `qss` injection into `*.ui` files
- [`pre-commit`](https://pre-commit.com/) hooks

## FAQ

- Q: Why is `PyQt5` not supported?

  A: `PyQt5` only ships a python specific version of `uic` and `rcc` breaking the tool API and
  compatibility with cpp projects.
  Use the matching version of `qt5-applications` as Qt tooling supplier.

## Contributors ✨

Thanks goes out to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://github.com/s-weigand"><img src="https://avatars.githubusercontent.com/u/9513634?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sebastian Weigand</b></sub></a><br /><a href="https://github.com/s-weigand/qt-dev-helper/commits?author=s-weigand" title="Code">💻</a> <a href="#ideas-s-weigand" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-s-weigand" title="Maintenance">🚧</a> <a href="#projectManagement-s-weigand" title="Project Management">📆</a> <a href="#infra-s-weigand" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/s-weigand/qt-dev-helper/commits?author=s-weigand" title="Tests">⚠️</a> <a href="https://github.com/s-weigand/qt-dev-helper/commits?author=s-weigand" title="Documentation">📖</a></td>
    <td align="center"><a href="https://github.com/jsnel"><img src="https://avatars.githubusercontent.com/u/3616369?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joris Snellenburg</b></sub></a><br /><a href="https://github.com/s-weigand/qt-dev-helper/pulls?q=is%3Apr+reviewed-by%3Ajsnel" title="Reviewed Pull Requests">👀</a></td>
  </tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/s-weigand/qt-dev-helper",
    "name": "qt-dev-helper",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "qt_dev_helper",
    "author": "Sebastian Weigand",
    "author_email": "s.weigand.phy@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/dd/b1/f3c471bc09806c1ed575d2892910c647822d6dbc938629937694654ea657/qt_dev_helper-0.0.4.tar.gz",
    "platform": null,
    "description": "# Qt Dev Helper\n\n[![PyPi Version](https://img.shields.io/pypi/v/qt_dev_helper.svg)](https://pypi.org/project/qt-dev-helper/)\n[![Supported Python Versions](https://img.shields.io/pypi/pyversions/qt_dev_helper.svg)](https://pypi.org/project/qt-dev-helper/)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/qt-dev-helper.svg)](https://anaconda.org/conda-forge/qt-dev-helper)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n[![Actions Status](https://github.com/s-weigand/qt-dev-helper/workflows/Tests/badge.svg)](https://github.com/s-weigand/qt-dev-helper/actions)\n[![Documentation Status](https://readthedocs.org/projects/qt-dev-helper/badge/?version=latest)](https://qt-dev-helper.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/gh/s-weigand/qt-dev-helper/branch/main/graph/badge.svg)](https://codecov.io/gh/s-weigand/qt-dev-helper)\n[![Documentation Coverage](https://raw.githubusercontent.com/s-weigand/qt-dev-helper/main/docs/_static/interrogate_badge.svg)](https://github.com/s-weigand/qt-dev-helper)\n[![Code style Python: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n[![All Contributors](https://img.shields.io/github/all-contributors/s-weigand/qt-dev-helper)](#contributors)\n\nToolbox to help develop Qt applications, improving the usability of the existing tooling.\n\n## Installation\n\n```console\npip install qt-dev-helper\n```\n\nOR\n\n```console\nconda install -c conda-forge qt-dev-helper\n```\n\n## Features\n\n- Usable as Library and/or CLI tool\n- Compatible with [PEP517](https://peps.python.org/pep-0517/) build system\n  ([see test case](https://github.com/s-weigand/qt-dev-helper/blob/main/tests/data/pyproject.toml))\n- CLI auto completion\n- Project wide configuration in `pyproject.toml`\n- Recursive asset compiler for Qt projects (using `uic` and `rcc`):\n  - `*.ui` -> `*.py`\n  - `*.qrc` -> `*.py`\n  - `*.ui` -> `*.h`\n  - `*.qrc` -> `*.h`\n  - `*.scss` -> `*.qss`\n- Support for multiple Qt tooling suppliers\n  - `PySide6-Essentials`\n  - `qt6-applications`\n  - `qt5-applications`\n- Ability to open all files in a folder in QtDesigner\n\n## Planned features\n\n- Stand alone executable for each release (Windows)\n- File watch mode\n- `qss` injection into `*.ui` files\n- [`pre-commit`](https://pre-commit.com/) hooks\n\n## FAQ\n\n- Q: Why is `PyQt5` not supported?\n\n  A: `PyQt5` only ships a python specific version of `uic` and `rcc` breaking the tool API and\n  compatibility with cpp projects.\n  Use the matching version of `qt5-applications` as Qt tooling supplier.\n\n## Contributors \u2728\n\nThanks goes out to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n  <tr>\n    <td align=\"center\"><a href=\"https://github.com/s-weigand\"><img src=\"https://avatars.githubusercontent.com/u/9513634?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>Sebastian Weigand</b></sub></a><br /><a href=\"https://github.com/s-weigand/qt-dev-helper/commits?author=s-weigand\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#ideas-s-weigand\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"#maintenance-s-weigand\" title=\"Maintenance\">\ud83d\udea7</a> <a href=\"#projectManagement-s-weigand\" title=\"Project Management\">\ud83d\udcc6</a> <a href=\"#infra-s-weigand\" title=\"Infrastructure (Hosting, Build-Tools, etc)\">\ud83d\ude87</a> <a href=\"https://github.com/s-weigand/qt-dev-helper/commits?author=s-weigand\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"https://github.com/s-weigand/qt-dev-helper/commits?author=s-weigand\" title=\"Documentation\">\ud83d\udcd6</a></td>\n    <td align=\"center\"><a href=\"https://github.com/jsnel\"><img src=\"https://avatars.githubusercontent.com/u/3616369?v=4?s=100\" width=\"100px;\" alt=\"\"/><br /><sub><b>Joris Snellenburg</b></sub></a><br /><a href=\"https://github.com/s-weigand/qt-dev-helper/pulls?q=is%3Apr+reviewed-by%3Ajsnel\" title=\"Reviewed Pull Requests\">\ud83d\udc40</a></td>\n  </tr>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "Tool to help developing Qt applications",
    "version": "0.0.4",
    "project_urls": {
        "Changelog": "https://qt-dev-helper.readthedocs.io/en/latest/history.html",
        "Documentation": "https://qt-dev-helper.readthedocs.io",
        "Homepage": "https://github.com/s-weigand/qt-dev-helper",
        "Source": "https://github.com/s-weigand/qt-dev-helper",
        "Tracker": "https://github.com/s-weigand/qt-dev-helper/issues"
    },
    "split_keywords": [
        "qt_dev_helper"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "db3f1b2c13e3fa233ae967b76af4eb5821e525edccf3529af513b6d003b53d3b",
                "md5": "06a88a7fbb480906f1707d71e5b7f411",
                "sha256": "c3bd1d7cb2ebf3f3ce7bcb1a546c60be02780ed72fe5349e3566022819814c16"
            },
            "downloads": -1,
            "filename": "qt_dev_helper-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "06a88a7fbb480906f1707d71e5b7f411",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 16631,
            "upload_time": "2023-07-08T01:14:45",
            "upload_time_iso_8601": "2023-07-08T01:14:45.885284Z",
            "url": "https://files.pythonhosted.org/packages/db/3f/1b2c13e3fa233ae967b76af4eb5821e525edccf3529af513b6d003b53d3b/qt_dev_helper-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ddb1f3c471bc09806c1ed575d2892910c647822d6dbc938629937694654ea657",
                "md5": "d43a181ab2858ec3632b3fa83d9761d4",
                "sha256": "789b85a6e64d1601cc42a000599b2bfb7481cebb501d759b97a8dfcaa981ac88"
            },
            "downloads": -1,
            "filename": "qt_dev_helper-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "d43a181ab2858ec3632b3fa83d9761d4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 34169,
            "upload_time": "2023-07-08T01:14:47",
            "upload_time_iso_8601": "2023-07-08T01:14:47.330476Z",
            "url": "https://files.pythonhosted.org/packages/dd/b1/f3c471bc09806c1ed575d2892910c647822d6dbc938629937694654ea657/qt_dev_helper-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-08 01:14:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "s-weigand",
    "github_project": "qt-dev-helper",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "qt-dev-helper"
}
        
Elapsed time: 0.27090s