Metadata-Version: 2.1
Name: pyonms
Version: 0.0.9
Summary: A Python library for accessing the OpenNMS REST API.
Project-URL: Homepage, https://github.com/mmahacek/PyONMS
Project-URL: Documentation, https://mmahacek.github.io/PyONMS/
Author-email: Mark Mahacek <mmahacek@opennms.com>
License-File: LICENSE.txt
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: python-dotenv
Requires-Dist: requests
Requires-Dist: tqdm
Requires-Dist: xmltodict
Description-Content-Type: text/markdown

![package version](https://img.shields.io/pypi/v/pyonms)
![python version](https://img.shields.io/pypi/pyversions/pyonms)

# PyONMS

A Python library for accessing the OpenNMS REST API.

This is being developed with Python 3.10 and OpenNMS 31.
It may work on older versions, but they haven't been tested yet.

- [OpenNMS REST API documentation](https://docs.opennms.com/horizon/31/development/rest/rest-api.html)

## Information

This currently is an early, pre-release version of this library.
It is not maintained or published by The OpenNMS Group.


## Endpoints Supported

Currently supported endpoints include:

* Alarms (read-only)
* Business Services (read-write)
* Events (read, send)
* Foreign Sources (read-write)
* Health (read-only)
* Info (read-only)
* Nodes (read-only)
* Requisitions (read-write)

## Getting Started

You can install this library by running:

```
pip3 install pyonms
```

See the [project documentation](https://mmahacek.github.io/PyONMS/) for instructions on using this library.
