Go to file

clerie a11629f543 Readable error messages when OMM is unreachable when using cli		2023-06-17 18:27:30 +02:00
docs	Restructuring api documentation	2022-05-01 22:43:52 +02:00
mitel_ommclient2	Readable error messages when OMM is unreachable when using cli	2023-06-17 18:27:30 +02:00
.gitignore	Add packaging information	2022-07-06 01:39:32 +02:00
LICENSE	Add license and attribution	2022-01-06 16:20:46 +01:00
README.md	Add cli to readme	2022-07-06 12:53:07 +02:00
flake.lock	add flake	2022-10-15 16:51:07 +02:00
flake.nix	Add cli to flake and set default	2022-10-16 11:48:57 +02:00
pyproject.toml	Add project script for cli	2022-07-06 12:50:16 +02:00

README.md

Mitel OMMClient2

Another attempt for a modern client library to the Mitel OM Application XML Interface.

Install

Without any additional dependencies:

pip install "mitel_ommclient2 @ git+https://git.clerie.de/clerie/mitel_ommclient2.git@main"

Add dependencies to enable secret handling, if you need it.

pip install "mitel_ommclient2[crypt] @ git+https://git.clerie.de/clerie/mitel_ommclient2.git@main"

Quicksart

Just some examples to give you an idea what this does.

import mitel_ommclient2

# Connect to your OMM
c = mitel_ommclient2.OMMClient2("omm.local", "admin", "admin")

# Use built in methods for common actions
c.ping()

# Create custom messages
m = mitel_ommclient2.messages.Ping()
m.timeStamp = 2342
r = c.connection.request(m)

Consult class documentation for more in depth examples and options.

Interactive CLI

The package installs a script called ommclient2. This allowes basic interactive testing of the library.

ommclient2 --help

Attribution

This software is inspired by python-mitel by Thomas and n-st.