Metadata-Version: 2.4
Name: pydm
Version: 1.28.3
Summary: A Python-Qt based framework for building user interfaces for control systems
Author: SLAC National Accelerator Laboratory
License: Copyright (c) 2017-2025, The Board of Trustees of the Leland Stanford
        Junior University, through SLAC National Accelerator Laboratory
        (subject to receipt of any required approvals from the U.S. Dept. of
        Energy). All rights reserved. Redistribution and use in source and
        binary forms, with or without modification, are permitted provided
        that the following conditions are met:
        
        (1) Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.
        
        (2) 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.
        
        (3) Neither the name of the Leland Stanford Junior University, SLAC
        National Accelerator Laboratory, U.S. Dept. of Energy 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, THE UNITED STATES GOVERNMENT, 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.
        
        You are under no obligation whatsoever to provide any bug fixes,
        patches, or upgrades to the features, functionality or performance of
        the source code ("Enhancements") to anyone; however, if you choose to
        make your Enhancements available either publicly, or directly to SLAC
        National Accelerator Laboratory, without imposing a separate written
        license agreement for such Enhancements, then you hereby grant the
        following license: a non-exclusive, royalty-free perpetual license to
        install, use, modify, prepare derivative works, incorporate into other
        computer software, distribute, and sublicense such Enhancements or
        derivative works thereof, in binary and source code form.
        
Project-URL: Homepage, https://github.com/slaclab/pydm
Project-URL: Documentation, https://slaclab.github.io/pydm/
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: entrypoints
Requires-Dist: numpy>=1.11.0
Requires-Dist: pyepics>=3.2.7
Requires-Dist: pyqtgraph>=0.12.0
Requires-Dist: qtpy>=2.2.0
Requires-Dist: six
Provides-Extra: test
Requires-Dist: codecov; extra == "test"
Requires-Dist: pytest>=3.6; extra == "test"
Requires-Dist: pytest-qt; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-timeout; extra == "test"
Requires-Dist: p4p; extra == "test"
Requires-Dist: pyca-epics; extra == "test"
Requires-Dist: pre-commit; extra == "test"
Provides-Extra: test-no-optional
Requires-Dist: codecov; extra == "test-no-optional"
Requires-Dist: pytest>=3.6; extra == "test-no-optional"
Requires-Dist: pytest-qt; extra == "test-no-optional"
Requires-Dist: pytest-cov; extra == "test-no-optional"
Requires-Dist: pytest-timeout; extra == "test-no-optional"
Provides-Extra: doc
Requires-Dist: doctr; extra == "doc"
Requires-Dist: sphinx==5.3.0; extra == "doc"
Requires-Dist: sphinx_rtd_theme; extra == "doc"
Requires-Dist: sphinxcontrib-napoleon; extra == "doc"
Dynamic: license-file

[![Build Status: PySide6](https://github.com/slaclab/pydm/actions/workflows/run-tests-pyqt5.yml/badge.svg?branch=master)](https://github.com/slaclab/pydm/actions/workflows/run-tests-pyqt5.yml)
[![Build Status: PyQt5](https://github.com/slaclab/pydm/actions/workflows/run-tests-pyside6.yml/badge.svg?branch=master)](https://github.com/slaclab/pydm/actions/workflows/run-tests-pyside6.yml)

![PyDM: Python Display Manager](pydm_banner_full.png)

<p>
  <img src="pydm_launcher/icons/pydm_128.png" width="128" height="128" align="right"/>
  <h1>PyDM: Python Display Manager</h1>
</p>

<p align="left">
  PyDM is a Python-Qt based framework for building user interfaces for control systems.
  The goal is to provide a no-code, drag-and-drop system to make simple screens,
  as well as a straightforward Python framework to build complex applications.
  <br>
  <br>
</p>
<p align="center">
  <strong>« Explore PyDM <a href="https://slaclab.github.io/pydm/">docs</a> and <a href="https://slaclab.github.io/pydm/tutorials/index.html">tutorials</a> »</strong>
  <br>
  <br>
  <a href="https://github.com/slaclab/pydm/issues/new?template=bug-report.md">Report bug</a>
  ·
  <a href="https://github.com/slaclab/pydm/issues/new?template=feature-request.md&labels=request">Request feature</a>
  ·
  <a href="https://github.com/slaclab/pydm/blob/master/CONTRIBUTING.rst">How to Contribute</a>
  ·
  <a href="https://github.com/slaclab/pydm/blob/master/SUPPORT.md">Support</a>
</p>

<br>

# Python Qt Wrapper
PyDM project uses the [qtpy](https://github.com/spyder-ide/qtpy)
as the abstraction layer for the Qt Python wrappers (PyQt5/PyQt4/PySide2/PySide6).
**All tests are performed with PyQt5**.

# Prerequisites
* Python >= 3.10, <= 3.12
* Qt 5.6 or higher
* qtpy
* PyQt5 >= 5.7 or PySide6 >= 6.9.2
> **Note:**
> If you'd like to use Qt Designer (drag-and-drop tool to build interfaces) you'll
> need to make sure you have the PyQt5/PySide6 plugin for Designer installed.  This usually
> happens automatically when you install PyQt5/PySide6 from source, but if you install it
> from a package manager, it may be left out.

Python package requirements are listed in the requirements.txt file, which can
be used to install all requirements from pip: 'pip install -r requirements.txt'

# Related Projects
[PyDMConverter](https://github.com/slaclab/pydm-converter-tool): A new tool for converting legacy control system displays (eg. EDM) into PyDM.

[Related Projects](RELATED_PROJECTS.md): a list of some active projects built using PyDM.

# Getting Started
For developers who wish to contribute to PyDM and modify the source code, please follow the "Getting Started!"
instructions found here: https://github.com/slaclab/pydm/blob/master/CONTRIBUTING.rst#get-started.

For users who want to just install and run PyDM, follow the "Installation"
instructions found in the docs: https://slaclab.github.io/pydm/installation.html

# Running the Tests
In order to run the tests you will need to install some dependencies that are
not part of the runtime dependencies of PyDM.

Assuming that you have cloned this repository do:

```bash
pip install -r dev-requirements.txt

python run_tests.py
```

If you want to see the coverage report do:
```bash
python run_tests.py --show-cov
```

# Running the Examples
There are various examples of some of the features of the display manager.
To launch a particular display run 'python scripts/pydm <filename>'.

There is a 'home' display in the examples directory with buttons to launch all
the examples:
```python
pydm examples/home.ui
```

# Building the Documentation Locally
In order to build the documentation you will need to install some dependencies
that are not part of the runtime dependencies of PyDM.

Assuming that you have cloned this repository do:

```bash
pip install -r docs-requirements.txt

cd docs
make html
```

This will generate the HTML documentation for PyDM at the `<>/docs/build/html`
folder. Look for the `index.html` file and open it with your browser.

# Online Documentation

Documentation is available at http://slaclab.github.io/pydm/.  Documentation is
somewhat sparse right now, unfortunately.

# Widget Designer Plugins
PyDM widgets are written in Python, and are loaded into Qt Designer via the PyQt5/PySide6 Qt
Designer Plugin.

For PyQt5, if you want to use the pydm widgets in Qt Designer, add the pydm directory
(which holds `register_pydm_designer_plugin.py`) to your `PYQTDESIGNERPATH` environment variable.
For PySide6, add the pydm directory to your `PYSIDE_DESIGNER_PLUGINS` environment variable instead.
Eventually, this will happen automatically in some kind of setup script.

# Easy Installing PyDM
## Using the source code
```sh
git clone https://github.com/slaclab/pydm.git
cd pydm
pip install .[all]
```

## Using Anaconda

When using Anaconda to install PyDM at a Linux Environment it will automatically
define the PYQTDESIGNERPATH environment variable pointing to /etc/pydm which
will have a file named designer_plugin.py which will make all the PyDM widgets
available to the Qt Designer. For more information please see
our <a href="https://slaclab.github.io/pydm/installation.html">installation guide</a>.
