Metadata-Version: 2.5
Name: openfire_restapi
Version: 1.0.0
Summary: A python client for interacting with Openfire's REST API plugin.
Keywords: openfire,xmpp
Author-email: Alliance Auth <adarnof@gmail.com>
Requires-Python: >=3.11,<3.16
Description-Content-Type: text/markdown
License-Expression: GPL-3.0-or-later
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
License-File: LICENSE
Requires-Dist: requests>=2.9.1
Requires-Dist: sphinx ; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
Requires-Dist: typing-extensions ; extra == "docs"
Requires-Dist: sphinx-markdown-builder ; extra == "docs"
Requires-Dist: myst-parser ; extra == "docs"
Requires-Dist: sphinx-rtd-theme ; extra == "docs"
Requires-Dist: requests-mock>=1.2.0 ; extra == "test"
Requires-Dist: coverage>=4.3.1 ; extra == "test"
Requires-Dist: pytest ; extra == "test"
Project-URL: Documentation, https://openfire-restapi.readthedocs.io/
Project-URL: Home, https://gitlab.com/allianceauth/openfire-restapi
Project-URL: Source, https://gitlab.com/allianceauth/openfire-restapi
Project-URL: Tracker, https://gitlab.com/allianceauth/openfire-restapi/-/issues
Provides-Extra: docs
Provides-Extra: test
Import-Name: openfire_restapi

openfire-restapi
================

[![View on PyPI](https://img.shields.io/pypi/v/openfire-restapi.svg?maxAge=2592000)](https://pypi.python.org/pypi/openfire-restapi/)
[![PyPI](https://img.shields.io/pypi/pyversions/openfire-restapi.svg)]()
[![PyPI](https://img.shields.io/pypi/l/openfire-restapi.svg?maxAge=2592000)]()
[![pipeline status](https://gitlab.com/allianceauth/openfire-restapi/badges/master/pipeline.svg)](https://gitlab.com/allianceauth/openfire-restapi/commits/master)
[![coverage report](https://gitlab.com/allianceauth/openfire-restapi/badges/master/coverage.svg)](https://gitlab.com/allianceauth/openfire-restapi/commits/master)
[![Documentation](https://app.readthedocs.org/projects/openfire-restapi/badge/?version=latest)](https://openfire-restapi.readthedocs.io/)


A python client for interacting with Openfire's [REST API plugin](https://www.igniterealtime.org/projects/openfire/plugin-archive.jsp?plugin=restAPI)

## Installation

Requires python >= 3.11 and REST API plugin >= 1.3.0

Install from PyPI:

    pip install openfire-restapi

Install from source:

    git clone git://github.com/allianceauth/openfire-restapi.git
    cd openfire-restapi
    pip install -e .

## Usage

    from openfire_restapi import OpenfireRestApiClient
    api = OpenfireRestApiClient('http://example.com:9090', 's3cr3t_k3y`)
    api.users.get_users()

See the [full documentation](https://openfire-restapi.readthedocs.io/) for more information.

## Development

For testing or building docs, install the optional dependencies:

    pip install openfire-restapi[test,docs]

Or:

    pip install -e .[test,docs]
