threedi-ws-client

websocket client for threedi websocket consumer endpoints


Keywords
threedi_ws_client
License
MIT
Install
pip install threedi-ws-client==0.0.5

Documentation

threedi-ws-client

Documentation Status

Quick start

Create a virtual python > 3.6 environment, run:

pip install -r requirements.txt

The active_simulations command takes a required keyword argument --env with the options

  • prod (production obviously)
  • stag (staging obviously)
  • local

You have to create a corresponding .env file for the destination environment. The prod.env file could look something like this:

API_USERNAME='micheal.jackson'
API_PASSWORD='sefdiee92u43dmslzxsad'
API_HOST='https://api.3di.live/v3.0'

To start the client run:

python threedi_ws_client/commands/active_simulations.py --env=<prod | stag | local>

Features

  • TODO

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.