A cookiecutter template for PyQt4 GUI applications
Python
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 594 commits ahead, 115 commits behind mandeep:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tests
{{cookiecutter.repo_name}}
.gitignore
.travis.yml
LICENSE
README.rst
cookiecutter.json
pytest.ini

README.rst

Cookiecutter-PyQt4 is a Cookiecutter template that assists users in their creation of GUI applications.

Features

  • GUI application template
  • Package creation with ready-made setup.py
  • Continuous integration with pre-built .travis.yml for Travis CI
  • Pre-assembled Pytest test suite with inclusion of pytest-qt and pytest-xvfb to enhance test experience
  • UI folder contains UI related data (images, icons) and UI elements used in main window

Installation

Prior to installing the PyQt4 cookiecutter, the cookiecutter package must be installed in the user's virtual environment. This is achieved via the following command:

$ pip install cookiecutter

With cookiecutter installed, the PyQt4 cookiecutter template can be installed with:

$ cookiecutter https://github.com/aeroaks/cookiecutter-pyqt4.git

Once cookiecutter clones the template, the user will be asked a series of questions related to their project:

$ full_name [user]: Enter your full name.

$ email [info@user.xyz]: Enter your email address.

$ github_username [user_git]: Enter your github username.

$ repo_name [cookiecutter-pyqt4]: Enter the name of your project's repository.

$ package_name [cookiecutter-pyqt4]: Enter the name of your application's package.

$ application_name [application]: Enter the name of your GUI application.

$ application_title [Template]: Enter the title of your application. This name is also used
  as an entry point into the application.

$ project_short_description [A PyQt4 GUI application]: Enter a short description about your project.

$ version [0.0.1]: Enter the version number for your application.

$ insert_toolbar [yes]: If you would like a tool bar on your application, press enter or type yes.

$ insert_statusbar [yes]: If you would like a movable status bar on your application, press enter or type yes.

Usage

With the questions during installation answered, the user will have a fully functioning Python project in their current working directory. This package will contain a GUI application template in the package directory as well as a test suite in the package's tests folder. All the user needs to finish coding is the rest of their GUI application and related tests.

Use run.py to run the GUI instance. application_name python file contains UI elements handling code for the whole window. worker/main_worker.py contains all the logic and UI element handling for the application_name python file Logging can be used to create log of the GUI session. Log files are erased when a new session is started.