{ "info": { "author": "Deep Dhillon", "author_email": "deep@deepdhillon.ca", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta" ], "description": "WQt - A Qt project manager\n==========================\n\nWQt is a Qt project management tool which allows the user to create,\nupdate, build, and run Qt projects from command line. It uses CMake to\nbuild the project, hence making it compatible with almost any text\neditor and IDE.\n\nInstall\n-------\n\nInstall from pip:\n\n::\n\n pip install wqt\n\nClone the repo and install using setup tools\n\n::\n\n git clone https://www.github.com/waterloop/wqt\n cd wqt\n python setup.py install\n\nPrerequisites\n-------------\n\nIn order for this tool to work, the user needs to make sure the\npreequisites discussed below are met.\n\n- Install ``Qt`` for your machine\n- Add Qt\u2019s bin folder to the path\n\n - This will depend on the compiler you installed through Qt\n installer\n - Ex: ``/usr/doge/applications/Qt/5.10.0/clang_64/bin``\n\n- Install ``CMake`` for your machine\n- Install ``Make`` and basic ``C/C++`` tools\n\nProject Structure\n-----------------\n\nWQt tries to define a project structure for the user. This is done to\norganize the Qt code and to make it is easier to build and compile. Any\ncustom structure may break the functionality of the tool and hence\nshould be avoided.\n\n::\n\n wqt create \n\nThe command above is used to create a project structure. This will\ninitialize the project will add template files to get the user started.\nQt can have multiple type of applications, hence **three** of these\napplications are supported: ``widgets``, ``quick`` and ``console``. The\n``create`` command will take an argument of which Qt application to\ncreate and one of the above can be specified. This will then create a\nproject structure for that particular application. The basic project\nstructure is as follow:\n\n::\n\n project/\n lib/\n src/\n res/\n wqt/\n cmake/\n helper/\n .gitignore\n properties.ini\n CMakeLists.txt\n\nConfigurations and Updates\n--------------------------\n\nEvery project needs to have some way of configuring properties and this\nis why there is a ``properties.ini`` file in every ``WQt`` project. This\nfile is very important because it contains critical information need to\nmake the ``build``, and ``run`` possible. This configuration file is\ndifferent based on which machine the project is created on. Config\nfiles\u2019 templates are:\n\n::\n\n [project]\n name:\n type:\n\n [version]\n cxx: 11\n qt: 5.10.0\n cmake: 2.8.0\n\n [library]\n qt: Core Quick\n user:\n\nLooking at these configuration files, you can see that the fields are\ndefined without user needed to change them. This is done because we\nwanted to have a system where the user ``creates`` the project and then\nit runs ``immediately``. The ``project -> name`` field is automatically\nfilled with the name of the project folder. Mac OS needs a bit more\ninformation to create a ``.app`` file and hence extra fields are\nprovided in the configuration file. **Note: These fields can be modified\nand the project will adjust accordingly.**\n\nIn order for the new configurations to take affect, ``update`` command\nis used\n\n::\n\n wqt update\n\nThis command updates the ``CMakeLists.txt`` file and makes necessary\nchanges to the project based on the ``config.json`` properties. This\ncommand is a must run for the new configurations to be accepted. **Note:\nit is useful to run his command after cloning a WQt project repo to have\nit customized according to your machine.**\n\nBuilding the project\n--------------------\n\nWQt provides a way to build the project with just one command. All the\nbuild files are stored in the ``wqt/build`` folder. This folder is\nincluded in the ``.gitignore`` by default. After building the project, a\n``bin`` folder is created to store the executable and all the resources\nit needs. This file is also a part of ``.gitignore`` by default. In the\norder to build the project, ``build`` command is used.\n\n::\n\n wqt build\n\nExecutable details\n~~~~~~~~~~~~~~~~~~\n\nExecutable generated by ``wqt`` is platform dependent. This is done to\ncreate ``.app`` application for Mac OS and normal executable for other\nplatforms. The ``config.json`` file has extra fields to specify the\nconfigurations for creating the executable for Mac OS. These fields are\nnot need on platforms like Windows and Linux. **Update the fields\nrelated to metadata in config.json to make sure the file contains the\nmetadata you want not the default one.** Also the icon file is also\nspecified in the config.json file. That name is then searched inside the\n``res/icons`` folder to find a file. So make sure your ``.icns`` is\nplaced in the ``res/icons`` folder to override the default icon.\n\nImportant information\n---------------------\n\nAs you all are reading this, you should know that all these commands\nonly work when you are in the project directory. If you are not in the\nproject directory, ``--path `` optional command can be added to\nspecify the project path.\n\nRun and Preview\n---------------\n\nQt is mostly used for creating graphical applications, so it won\u2019t be\nfun if you couldn\u2019t run and preview the application. WQt comes with two\nsuch commands which can help you preview and run your project code. The\nfirst such command is ``run``\n\n::\n\n wqt run\n\nThis command will ``build`` the project and opens the ``executable``\nfile on your machine. This feature is supported on ``windows``,\n``mac OS`` and ``linux``. This does not work on ``windows subsystem`` or\nany other ``linux emulator`` running on ``windows``.\n\nThe other such command is ``preview-qml``. As the name suggest it helps\nyou preview the ``qml`` files in your project. For this command to work\nyour project application type has to be ``quick``. In order to find the\n``qml`` files in your project, the tool looks into the ``res/qml``\nfolder and shows you a list of those files. You can then run\n\n::\n\n wqt list-qml\n\n::\n\n wqt preview-qml \n\nAs a side note the tool accepts both the full name with extention and\nwithout extension.\n\nOther useful commands and features\n----------------------------------\n\n``open``\n~~~~~~~~\n\nIf an executable is built, this opens that executable. This does not\nbuild the project.\n\n::\n\n wqt open\n\n``list-libs``\n~~~~~~~~~~~~~\n\nThis command is useful if you want to see which ``Qt`` libraries are\nincluded in the project. These are the ``core Qt`` libraries and not\ncustom libraries.\n\n::\n\n wqt list-libs\n\n``add-lib``\n~~~~~~~~~~~\n\nThis command is useful if you want to add a ``core Qt`` library to the\nproject. The tool will add this library to the ``config.json`` file and\nwill update the project for the changes to take an affect. Next time\nwhen the project builds, that library is used in the build. There are no\nchecks performed to see if this library being added is indeed\n``core Qt`` library.\n\n::\n\n wqt add-lib \n\n``rm-lib``\n~~~~~~~~~~\n\nThis command is useful if you want to remove a ``core Qt`` library from\nthe project. The tool will remove this library from the ``config.json``\nfile and will update the project for the changes to take an affect. Next\ntime when the project builds, that library is not used in the build.\n\n::\n\n wqt add-lib \n\n``list-types``\n~~~~~~~~~~~~~~\n\nThis command is is useful to see which ``Qt`` application types are\ncompatible with WQt. It will show the list of those application types.\n\n::\n\n wqt list-types\n\nUpdates\n-------\n\n- Version 1.1.1\n\n - Replaced ``config.json`` with ``properties.ini``\n - Added ``open`` command\n - Project also updates when ``build`` is executed\n - Handles more error cases\n - Separate ``properties`` and ``cmake`` for each OS and qt type\n - Resource are handled exactly like Qt Creator does\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/dhillondeep/wqt", "keywords": "qt", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "WQt", "package_url": "https://pypi.org/project/WQt/", "platform": "", "project_url": "https://pypi.org/project/WQt/", "project_urls": { "Homepage": "https://github.com/dhillondeep/wqt" }, "release_url": "https://pypi.org/project/WQt/1.1.1/", "requires_dist": null, "requires_python": "", "summary": "Create, Build, and Run Qt Projects", "version": "1.1.1" }, "last_serial": 3572820, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "824da1b7a88f09e69cf99d7f3f058ec8", "sha256": "3ac1b451e69fc5a6ae5aa4136d99b6561b1e92fb9d7b90bb32a365c2e42ba578" }, "downloads": -1, "filename": "WQt-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "824da1b7a88f09e69cf99d7f3f058ec8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2439, "upload_time": "2018-02-04T17:07:10", "url": "https://files.pythonhosted.org/packages/f0/93/114e164cb3ff564305b65a3f1e6d242c2fc7c70946fac162208217f007aa/WQt-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a86784ce28b640b668da7ed5386d8689", "sha256": "373f97f206f55487705097f9eb8491b2eb9ab5205c8807219422aa22a363a848" }, "downloads": -1, "filename": "WQt-1.0.0.tar.gz", "has_sig": false, "md5_digest": "a86784ce28b640b668da7ed5386d8689", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1351, "upload_time": "2018-02-04T16:33:49", "url": "https://files.pythonhosted.org/packages/b2/4b/7d337aa63de724de692e4aca00e946996d526ca75686b38e95f0afee8680/WQt-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "0e53acfc876b5fc4660a3710df8c2d97", "sha256": "4548540043423ae992e08ecb8c312800e258365e16fc270e8c94363c192f9a31" }, "downloads": -1, "filename": "WQt-1.0.1.tar.gz", "has_sig": false, "md5_digest": "0e53acfc876b5fc4660a3710df8c2d97", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1422, "upload_time": "2018-02-04T17:22:55", "url": "https://files.pythonhosted.org/packages/5d/54/c02eaa6000f48e41af24117e9b800cb2c470a503cf617f19f0e8a1eae66c/WQt-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "1e0340a6ab4fd3da8dc9c2581cf1ce31", "sha256": "6082dcb496468b6c339e72fb48157d70a1f2d551d33a55dd047ccdd5a846c32c" }, "downloads": -1, "filename": "WQt-1.0.2.tar.gz", "has_sig": false, "md5_digest": "1e0340a6ab4fd3da8dc9c2581cf1ce31", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1424, "upload_time": "2018-02-04T17:46:13", "url": "https://files.pythonhosted.org/packages/c9/99/457e13b081fe478c5d57513c452cb7638d923c8dcec5f80576afff98294c/WQt-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "eecb9037f848d7553611c3cf7c688277", "sha256": "94775a4e552584a7dbbf791cb6b2a46bc26b043411e7e6919bc1ed88024a5df8" }, "downloads": -1, "filename": "WQt-1.0.3.tar.gz", "has_sig": false, "md5_digest": "eecb9037f848d7553611c3cf7c688277", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1423, "upload_time": "2018-02-04T18:48:12", "url": "https://files.pythonhosted.org/packages/be/53/fa5036478c173cada5b324c64b9b09d99003ebe62abc58a861e55d024242/WQt-1.0.3.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "f78a75c7f6d1aaf0ae106cffc70fabcb", "sha256": "10539af3957898968b0ad75d84d4af62ee0b25bac6e7f30c58143611b85bceea" }, "downloads": -1, "filename": "WQt-1.0.4.tar.gz", "has_sig": false, "md5_digest": "f78a75c7f6d1aaf0ae106cffc70fabcb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1416, "upload_time": "2018-02-04T19:48:22", "url": "https://files.pythonhosted.org/packages/8a/89/f46039d1412a3783d0597d624621b46b278749c6df539aeb986a96f4a900/WQt-1.0.4.tar.gz" } ], "1.0.5": [ { "comment_text": "", "digests": { "md5": "e27b8bbf182130e65147ffa44ac8059d", "sha256": "0d6804259eb7b8e4070b8af078154d2292845dc360b2449a4c6929547364ad2c" }, "downloads": -1, "filename": "WQt-1.0.5.tar.gz", "has_sig": false, "md5_digest": "e27b8bbf182130e65147ffa44ac8059d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4587, "upload_time": "2018-02-04T22:38:16", "url": "https://files.pythonhosted.org/packages/92/18/238f21bc8dce0e00c3a6cca3d0fd345ee3abbe56bd3a9ae00a3382b7d032/WQt-1.0.5.tar.gz" } ], "1.0.6": [ { "comment_text": "", "digests": { "md5": "cf45ff0b9479fabcfb4f34754cc133bb", "sha256": "7d7df12f52801635150072fde49c8862934dfc08ec803b7dfb0457b8909e66ba" }, "downloads": -1, "filename": "WQt-1.0.6.tar.gz", "has_sig": false, "md5_digest": "cf45ff0b9479fabcfb4f34754cc133bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 286546, "upload_time": "2018-02-05T20:46:50", "url": "https://files.pythonhosted.org/packages/bd/97/8f40c7beebe19177152004c07a25577f0027c75ce5d838f03ec59906b9f4/WQt-1.0.6.tar.gz" } ], "1.0.7": [ { "comment_text": "", "digests": { "md5": "55ccbab4dd5dd105c39927ec420f93aa", "sha256": "b0f7d51ce120e0e1f6eb7957a7ba7ff7f1b529f5fd39bffa181294a2183ce765" }, "downloads": -1, "filename": "WQt-1.0.7.tar.gz", "has_sig": false, "md5_digest": "55ccbab4dd5dd105c39927ec420f93aa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 287290, "upload_time": "2018-02-05T21:48:59", "url": "https://files.pythonhosted.org/packages/91/ce/fb332ed73c8640ce833033f52921e9f34b7e8fe51a3c379faee5b8934b93/WQt-1.0.7.tar.gz" } ], "1.0.8": [ { "comment_text": "", "digests": { "md5": "22248ee8db73b3ba9aaaff13766b1fea", "sha256": "8199086f9cc53a450ad60a28695dcbe46c69a7c88b87c7f3ff2c77a66310b616" }, "downloads": -1, "filename": "WQt-1.0.8.tar.gz", "has_sig": false, "md5_digest": "22248ee8db73b3ba9aaaff13766b1fea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 287319, "upload_time": "2018-02-05T21:52:08", "url": "https://files.pythonhosted.org/packages/fc/66/715edd26cfdf7799306e9b3a6977b8e72c7e1fdf4d3183f0f366ff190939/WQt-1.0.8.tar.gz" } ], "1.0.9": [ { "comment_text": "", "digests": { "md5": "0d32dc6b92a8f5c49e46826d7bfe3884", "sha256": "066ca004278dca0dd747de0b377d6451910efe13937bbf3dc534ac5f39e184af" }, "downloads": -1, "filename": "WQt-1.0.9.tar.gz", "has_sig": false, "md5_digest": "0d32dc6b92a8f5c49e46826d7bfe3884", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 287316, "upload_time": "2018-02-05T22:00:51", "url": "https://files.pythonhosted.org/packages/cf/fb/560bedf37a321005fe8b854e52548d98039196b93d4826a0b7ff68b1b0c4/WQt-1.0.9.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "f5ee8e67f57853ff87d61de9584cc8d9", "sha256": "3ef63cc32a78d81ee5dd24c86be0bbbc44a2f873d383a57536e7484b16105625" }, "downloads": -1, "filename": "WQt-1.1.0.tar.gz", "has_sig": false, "md5_digest": "f5ee8e67f57853ff87d61de9584cc8d9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 288075, "upload_time": "2018-02-06T07:31:27", "url": "https://files.pythonhosted.org/packages/6c/23/25311ec308c12fa4d539567f3f0999ee8bf8495450c1c5d7769886e3f30d/WQt-1.1.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "74b9f9ce08cb40e9261fbc60316e3902", "sha256": "5347521ce8db6f4d4a45a1731de4c128fe41652ea23395bf596da340cc0ee2fc" }, "downloads": -1, "filename": "WQt-1.1.1.tar.gz", "has_sig": false, "md5_digest": "74b9f9ce08cb40e9261fbc60316e3902", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 194029, "upload_time": "2018-02-11T20:46:08", "url": "https://files.pythonhosted.org/packages/49/14/dd2d2e6f53259b3c41da6170bd61ca9ffe4212d0005a2ad90d60c94a4848/WQt-1.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "74b9f9ce08cb40e9261fbc60316e3902", "sha256": "5347521ce8db6f4d4a45a1731de4c128fe41652ea23395bf596da340cc0ee2fc" }, "downloads": -1, "filename": "WQt-1.1.1.tar.gz", "has_sig": false, "md5_digest": "74b9f9ce08cb40e9261fbc60316e3902", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 194029, "upload_time": "2018-02-11T20:46:08", "url": "https://files.pythonhosted.org/packages/49/14/dd2d2e6f53259b3c41da6170bd61ca9ffe4212d0005a2ad90d60c94a4848/WQt-1.1.1.tar.gz" } ] }