Metadata-Version: 2.2
Name: slac-alarm-manager
Version: 1.4.0
Summary: Python interface for managing alarms
Author: SLAC National Accelerator Laboratory
License: Copyright (c) 2017 – 2024, 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/slac-alarm-manager
Project-URL: Documentation, https://slaclab.github.io/slac-alarm-manager/
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: kafka-python
Requires-Dist: pydm
Requires-Dist: PyQt5
Requires-Dist: qtpy
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-qt; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"

[![CI Status](https://github.com/slaclab/slac-alarm-manager/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/slaclab/slac-alarm-manager/actions/workflows/build-and-test.yml)

## SLAC Alarm Manger

A user interface for monitoring and managing alarms written in Python. It is a frontend display for [NALMS](https://github.com/slaclab/nalms) and
requires a running NALMS deployment to interact with. Specifically it will consume messages from the kafka queue in order to put
together the alarm tree hierarchy, and then continue to read updates to alarm severity in order to display them in the tree
and table views.

In addition to displaying data, this interface will allow users to take actions on alarms such as acknowledgments and enabling/disabling
specific alarms. These actions will be written into the kafka queue so that if multiple users have multiple copies of this
application running, each user will receive any commands run by each other user.


## Requirements

* Python 3.9+
* pydm
* kafka-python
* qtpy
* A Qt Python wrapper

Most requirements are listed in the `requirements.txt` file, but the qt wrapper is not allowing flexibility in the choice.

## Installation

This package can be installed from PyPI using the command `pip install slac-alarm-manager`.

Alternatively, it may also be installed from source by cloning the code from the repository, and running
`pip install .` from the top level slam directory. `pip install -e .` may also be used for to allow for easier development
on the project.

## Running Tests

In order to run all of the tests included with this project, a few additional test-only requirements must be installed
as included in `dev-requirements.txt`. This test suite will also be run as part of every pull request, and whenever
a new commit is made to main.

## User Documentation

https://slaclab.github.io/slac-alarm-manager/
