clerie/mitel_ommclient2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Give some quickstart documentation

Browse Source
This commit is contained in:
clerie 2022-01-06 16:13:05 +01:00
parent 80357a49d1
commit e5938a0cc6
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,3 +1,25 @@
# Mitel OMMClient2
Another attempt for a client library to the Mitel OM Application XML Interface.
## 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
r = c.session.request(mitel_ommclient2.messages.Ping(timeStamp=2342))
# Craft your own request, if it is not implemented yet
r = c.session.request(mitel_ommclient2.messages.DictRequest("Ping", {"timeStamp": 2342}))
```
Consult class documentation for more in depth examples and options.