Metadata-Version: 2.1
Name: pyface
Version: 8.0.0
Summary: Traits-capable windowing framework
Author-email: Enthought <info@enthought.com>
License: This software is OSI Certified Open Source Software.
        OSI Certified is a certification mark of the Open Source Initiative.
        
        Copyright (c) 2006, Enthought, Inc.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
         * Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
         * Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
         * Neither the name of Enthought, Inc. nor the names of its contributors may
           be used to endorse or promote products derived from this software without
           specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
        ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: source, https://github.com/enthought/pyface
Project-URL: docs, https://docs.enthought.com/pyface
Keywords: gui,traits,traitsui,pyqt,pyside,wxpython
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE-CC-BY-3.0.txt
License-File: LICENSE.txt
Requires-Dist: traits>=6.2
Requires-Dist: importlib-metadata>=3.6; python_version < "3.10"
Requires-Dist: importlib-resources>=1.1.0; python_version < "3.9"
Provides-Extra: docs
Requires-Dist: enthought-sphinx-theme; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Provides-Extra: examples
Requires-Dist: traitsui; extra == "examples"
Requires-Dist: numpy; extra == "examples"
Provides-Extra: numpy
Requires-Dist: numpy; extra == "numpy"
Provides-Extra: pillow
Requires-Dist: pillow; extra == "pillow"
Provides-Extra: pyqt5
Requires-Dist: pyqt5; extra == "pyqt5"
Requires-Dist: pygments; extra == "pyqt5"
Provides-Extra: pyqt6
Requires-Dist: pyqt6; extra == "pyqt6"
Requires-Dist: pygments; extra == "pyqt6"
Provides-Extra: pyside2
Requires-Dist: pyside2; extra == "pyside2"
Requires-Dist: pygments; extra == "pyside2"
Provides-Extra: pyside6
Requires-Dist: pyside6; extra == "pyside6"
Requires-Dist: pygments; extra == "pyside6"
Provides-Extra: test
Requires-Dist: packaging; extra == "test"
Provides-Extra: traitsui
Requires-Dist: traitsui; extra == "traitsui"
Provides-Extra: wx
Requires-Dist: wxPython>=4; extra == "wx"
Requires-Dist: numpy; extra == "wx"

==========================================
Pyface: Traits-capable Windowing Framework
==========================================

The Pyface project contains a toolkit-independent GUI abstraction layer,
which is used to support the "visualization" features of the Enthought Tool
Suite libraries.  Pyface contains Traits-aware wrappers of standard GUI
elements such as Windows, Dialogs and Fields, together with the "Tasks"
application framework which provides a rich GUI experience with dock panes,
tabbed editors, and so forth.  This permits you to write cross-platform
interactive GUI code without needing to use the underlying GUI backend.

The following GUI backends are supported:

- PySide2 (stable) and PySide6 (experimental)
- PyQt5 (stable) and PyQt6 (in development)
- wxPython 4 (experimental)

Example
-------

The following code creates a window with a simple Python shell:

..  code-block:: python

    from pyface.api import ApplicationWindow, GUI, IPythonShell

    class MainWindow(ApplicationWindow):
        """ The main application window. """

        #: The PythonShell that forms the contents of the window
        shell = Instance(IPythonShell, allow_none=False)

        def _create_contents(self, parent):
            """ Create the editor. """
            self.shell.create(parent)
            return self.shell.control

        def destroy(self):
            self.shell.destroy()
            super().destroy()

        def _shell_default(self):
            from pyface.api import PythonShell
            return PythonShell()

    # Application entry point.
    if __name__ == "__main__":
        # Create the GUI.
        gui = GUI()

        # Create and open the main window.
        window = MainWindow(title="Python Shell", size=(640, 480))
        window.open()

        # Start the GUI event loop!
        gui.start_event_loop()

..  image:: https://raw.github.com/enthought/pyface/main/shell_window.png
    :alt: A Pyface GUI window containing a Python shell.

Installation
------------

Pyface is a pure Python package.  In most cases Pyface will be installable
using a simple ``pip install`` command.

To install with a backend, choose one of the following, as appropriate:

..  code-block:: console

    $ pip install pyface[pyside2]

    $ pip install pyface[pyside6]

    $ pip install pyface[pyqt5]

    $ pip install pyface[wx]

Some optional functionality uses ``pillow`` and ``numpy`` and these can be
installed using optional dependencies:

..  code-block:: console

    $ pip install pyface[pillow]

    $ pip install pyface[numpy]

For running tests a few more packages are required:

..  code-block:: console

    $ pip install pyface[test]

Documentation
-------------

* `Online Documentation <http://docs.enthought.com/pyface/>`_.

* `API Documentation <http://docs.enthought.com/pyface/api/pyface.html>`_.

.. end_of_long_description

Developing Pyface
-----------------

The `etstool.py` script provides utilities to assist developers wanting to work
on Pyface.  To use it, you will need to have the source checked out via Git,
Enthought's `EDM <http://docs.enthought.com/edm/>`__ distribution manager, and
a minimal environment containing at least the
`Click <http://click.pocoo.org/>`__ library.

You can then follow the instructions in ``etstool.py``.  In particular:

- use `etstool.py install` to create environments for particular toolkits and
  runtimes
- use `etstool.py shell` to activate those environments
- use `etstool.py test` to run the tests in those environments
- use `etstool.py flake8` to perform style checks
- use `etstool.py docs` to build the documentation
- use `etstool.py test-all` to run the tests across all supported runtimes and toolkits

License
-------

Pyface source code is licensed with a BSD-style license.  Some default images
are licensed with other licenses. See the license files for further
information.
