A library for interacting with the Mist Systems API
Project description
dartmist
A library for interacting with the Mist Systems API
Requirements
Python libraries
- websocket
- websocket-client
Installation
pip3 install dartmist
Will install this library and all required libraries
Setup
Environment
You must specify a Mist Org ID and a Mist API Token. These can be passed in via the command line (see Usage) or, preferably, set as envinronment variables:
export MIST_ORGID="00000000-0000-0000-0000-000000000000"
export MIST_TOKEN="12345123451234512345123451234512345"
To get an API Token, refer to the documentation provided by Mist https://api.mist.com/api/v1/docs/Auth#api-token
Usage
In your python script:
from dartmist import mist, misthelpers
api = mist.Mist(TOKEN, ORGID)
helper = misthelpers.MistHelpers(api)
To use the MistWebsocket class:
import threading
ev = threading.Event()
mwsock = mistwebsocket.MistWebsocket(TOKEN, ev)
mswock.open()
if ws.is_open:
print("Yes, the Websocket is open")
else:
logging.error("Failed to open Websocket")
exit(-1)
mwsock.subscribe()
while not ev.isSet() and len(ws.messages) == 0:
logging.debug("Waiting...")
msg_rcvd = ev.wait(10)
if msg_rcvd or ev.isSet() or len(ws.messages) > 0:
# Process messages
msg = json.loads(ws.get_next_message())
mwsock.unsubscribe()
mwsock.close()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
dartmist-0.1.0.tar.gz
(4.5 kB
view details)
Built Distribution
dartmist-0.1.0-py3-none-any.whl
(33.6 kB
view details)
File details
Details for the file dartmist-0.1.0.tar.gz
.
File metadata
- Download URL: dartmist-0.1.0.tar.gz
- Upload date:
- Size: 4.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4805890239e4c3c71d1ff5dd872d4bed8c471c7685137fce710c5cc7830336e1 |
|
MD5 | aac0474d08bb92be07a730b6bae842ac |
|
BLAKE2b-256 | 8814c1e8d576691f5abfd8be4f155c2e4a7afa9391f85476398d9b4109270d33 |
File details
Details for the file dartmist-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: dartmist-0.1.0-py3-none-any.whl
- Upload date:
- Size: 33.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.6.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7378c2e4b276bffda7a145631d318c2fedfee5dc29e06a767eea6f03d64f3058 |
|
MD5 | 47084dde2df783d27aba8990111d461b |
|
BLAKE2b-256 | 324d4998ca5d5b41ec5629c053b4367d5b0a1158b34d5d4f2d48327e435d3bd6 |