mitel_ommclient2/README.md

52 lines
1.1 KiB
Markdown
Raw Normal View History

2022-01-06 12:35:28 +01:00
# Mitel OMMClient2
2022-01-17 12:29:14 +01:00
Another attempt for a modern client library to the Mitel OM Application XML Interface.
2022-01-06 16:13:05 +01:00
2022-07-06 01:46:32 +02:00
## 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"
```
2022-01-06 16:13:05 +01:00
## 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
2022-05-01 23:57:37 +02:00
m = mitel_ommclient2.messages.Ping()
m.timeStamp = 2342
r = c.connection.request(m)
2022-01-06 16:13:05 +01:00
```
Consult class documentation for more in depth examples and options.
2022-01-06 16:20:46 +01:00
2022-07-06 12:53:07 +02:00
## Interactive CLI
The package installs a script called `ommclient2`.
This allowes basic interactive testing of the library.
```
ommclient2 --help
```
2022-01-06 16:20:46 +01:00
## Attribution
This software is inspired by `python-mitel` by Thomas and n-st.