[](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.6+
* 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/
Raw data
{
"_id": null,
"home_page": "https://github.com/slaclab/slac-alarm-manager",
"name": "slac-alarm-manager",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "SLAC National Accelerator Laboratory",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/51/5f/b4ca013f25516345f78c798426715cb03c409aed0944342aa3a60fc012b0/slac-alarm-manager-1.2.1.tar.gz",
"platform": null,
"description": "[](https://github.com/slaclab/slac-alarm-manager/actions/workflows/build-and-test.yml)\n\n## SLAC Alarm Manger\n\nA user interface for monitoring and managing alarms written in Python. It is a frontend display for [NALMS](https://github.com/slaclab/nalms) and\nrequires a running NALMS deployment to interact with. Specifically it will consume messages from the kafka queue in order to put \ntogether the alarm tree hierarchy, and then continue to read updates to alarm severity in order to display them in the tree\nand table views.\n\nIn addition to displaying data, this interface will allow users to take actions on alarms such as acknowledgments and enabling/disabling\nspecific alarms. These actions will be written into the kafka queue so that if multiple users have multiple copies of this\napplication running, each user will receive any commands run by each other user.\n\n\n## Requirements\n\n* Python 3.6+\n* pydm\n* kafka-python\n* qtpy\n* A Qt Python wrapper\n\nMost requirements are listed in the `requirements.txt` file, but the qt wrapper is not allowing flexibility in the choice.\n\n## Installation\n\nThis package can be installed from PyPI using the command `pip install slac-alarm-manager`.\n\nAlternatively, it may also be installed from source by cloning the code from the repository, and running\n`pip install .` from the top level slam directory. `pip install -e .` may also be used for to allow for easier development\non the project.\n\n## Running Tests\n\nIn order to run all of the tests included with this project, a few additional test-only requirements must be installed\nas included in `dev-requirements.txt`. This test suite will also be run as part of every pull request, and whenever\na new commit is made to main.\n\n## User Documentation\n\nhttps://slaclab.github.io/slac-alarm-manager/\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Python interface for managing alarms",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/slaclab/slac-alarm-manager"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1c74350663d0c82f682f3e5f8047eb7824432e475d6403887da70fd6196d8898",
"md5": "f93b40dadab4c33fe2cee3b6d060a555",
"sha256": "33cbb26e86662909ee39865f591d31f7a58dcaaa164018e9dfea05c3439559e2"
},
"downloads": -1,
"filename": "slac_alarm_manager-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f93b40dadab4c33fe2cee3b6d060a555",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 30836,
"upload_time": "2023-05-30T16:56:43",
"upload_time_iso_8601": "2023-05-30T16:56:43.810149Z",
"url": "https://files.pythonhosted.org/packages/1c/74/350663d0c82f682f3e5f8047eb7824432e475d6403887da70fd6196d8898/slac_alarm_manager-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "515fb4ca013f25516345f78c798426715cb03c409aed0944342aa3a60fc012b0",
"md5": "9e82993ef9147abb1c67df275738f480",
"sha256": "0a1cec63cc74bc960341a1540a527457a5240ca3020d1fa5338035fcdd2ffb64"
},
"downloads": -1,
"filename": "slac-alarm-manager-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "9e82993ef9147abb1c67df275738f480",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23958,
"upload_time": "2023-05-30T16:56:45",
"upload_time_iso_8601": "2023-05-30T16:56:45.419448Z",
"url": "https://files.pythonhosted.org/packages/51/5f/b4ca013f25516345f78c798426715cb03c409aed0944342aa3a60fc012b0/slac-alarm-manager-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-30 16:56:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "slaclab",
"github_project": "slac-alarm-manager",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "slac-alarm-manager"
}
JSON
