Skip to main content

openfire-restapi

View on PyPI PyPI PyPI pipeline status coverage report Documentation

A python client for interacting with Openfire's REST API plugin

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 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]

Metadata

Release files for openfire-restapi 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openfire-restapi 1.0.0
File Size Uploaded Provenance
openfire_restapi-1.0.0.tar.gz 27.0 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for openfire-restapi 1.0.0
File Interpreter ABI Platform
openfire_restapi-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 58.7 kB

Release files / openfire_restapi-1.0.0.tar.gz

Download URL openfire_restapi-1.0.0.tar.gz
Size 27.0 kB
Tags Source
SHA-256 checksum
How to use checksums
40b8d7b22cdac5bedc8d7d62311f6450f13338e219aa3a86626a58417103ea59
BLAKE2b-256 checksum
How to use checksums
05796ca56116ecdd97bdbf4cb25548305fae3faf43866644c347e9b62a575530
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.14.9

Release files / openfire_restapi-1.0.0-py3-none-any.whl

Download URL openfire_restapi-1.0.0-py3-none-any.whl
Size 31.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
127fb0d626cd07fb57a63ab9ee55f2555eb4d755616d1c4f2d7878e6cc1d68ec
BLAKE2b-256 checksum
How to use checksums
1fa568446be0a3e31eee1cf34bebcef7dbb3e0db91c843625db17a3223bfa891
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.14.9

Security for openfire-restapi 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page