{"id":13595751,"url":"https://github.com/gmarull/pyside2-boilerplate","last_synced_at":"2025-10-05T02:24:10.525Z","repository":{"id":89295831,"uuid":"122316686","full_name":"gmarull/pyside2-boilerplate","owner":"gmarull","description":"Qt for Python Application Boilerplate: Resources, forms, multilanguage, compilation, docs, linting...","archived":false,"fork":false,"pushed_at":"2021-10-05T12:34:02.000Z","size":292,"stargazers_count":189,"open_issues_count":1,"forks_count":35,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-12-08T21:07:36.484Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gmarull.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-02-21T09:34:36.000Z","updated_at":"2024-11-15T18:07:46.000Z","dependencies_parsed_at":"2023-03-15T00:17:22.637Z","dependency_job_id":null,"html_url":"https://github.com/gmarull/pyside2-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmarull%2Fpyside2-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmarull%2Fpyside2-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmarull%2Fpyside2-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmarull%2Fpyside2-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gmarull","download_url":"https://codeload.github.com/gmarull/pyside2-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230479864,"owners_count":18232630,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T16:01:56.984Z","updated_at":"2025-10-05T02:24:05.497Z","avatar_url":"https://github.com/gmarull.png","language":"Python","funding_links":[],"categories":["others","Python"],"sub_categories":[],"readme":"Qt for Python Application Boilerplate\n======================================\n\nThis repository contains a boilerplate for Qt for Python (PySide2) based\napplications.\n\n.. image:: https://user-images.githubusercontent.com/25011557/36483230-da4620c6-1715-11e8-9ee5-c10053641440.png\n    :alt: Qt for Python Application Boilerplate\n\nFeatures\n--------\n\n- Dependency management using ``pip``\n- Use the *standard* ``setup.py`` to build resources, docs, etc.\n- Manage resources and UI forms using a Qt Creator project\n- Generate a *compiled* application for Windows, Linux and macOS using\n  PyInstaller_\n- Multilanguage support\n- Document using Sphinx_\n- Flake8 linting\n\nGetting started\n---------------\n\nFirst of all create a new virtual environment and activate it::\n\n    python3 -m venv .venv\n    source .venv/bin/activate\n\n\nThen install the application in development mode::\n\n    pip install -e .\n\nFinally install development dependencies::\n\n    pip install -r requirements-dev.txt\n\nAutogenerated files such as translation binaries or compiled forms are required\nbut not pushed to the repository, so the first time you will need to generate\nthem as described in the coming section. Once done, you can run the application\nlike this::\n\n    python -m app\n\nResources and translations\n--------------------------\n\nIn order to ease the development process, the Qt Creator project ``app.pro`` is\nprovided. You can open it to edit the UI files or to manage resources.\nTranslations can be edited using Qt Linguist, part of the Qt SDK. In order to\nbuild the translations, you will need to have the ``lrelease`` command on your\n``PATH`` or set its full path to the ``LRELEASE_BIN`` environment variable.\nUI files, translations and resources can be built like this::\n\n    python setup.py build_res\n\nNote that this command is automatically run before running ``sdist`` and\n``bdist_app`` commands.\n\nCompiled application\n--------------------\n\nYou can generate a *compiled* application so that end-users do not need to\ninstall anything. You can tweak some settings on the ``app.spec`` file. It can\nbe generated like this::\n\n    python setup.py bdist_app\n\nDocumentation\n-------------\n\nSphinx_ is used for documentation purposes. You can tweak its configuration in\n``docs/conf.py`` and the documentation can be built like this::\n\n    python setup.py build_docs\n\nLinting\n-------\n\nFlake8 is a great tool to check for style issues, unused imports and similar\nstuff. You can tweak ``.flake8`` to ignore certain types of errors, increase the\nmaximum line length, etc. You can run it like this::\n\n    flake8 app\n\n\n.. _PyInstaller: http://www.pyinstaller.org/\n.. _Sphinx: http://www.sphinx-doc.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgmarull%2Fpyside2-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgmarull%2Fpyside2-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgmarull%2Fpyside2-boilerplate/lists"}