{ "info": { "author": "matej", "author_email": "matej.dujic@visionect.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5" ], "description": "This is a package implementing Visionect API in Python (version 2.7.11+ and 3.5.1+).\n\nPackage is still in beta, for any troubles post issues on: `github repo `__\n\nCheck `API documentation `__ for more info.\n\nAPI endpoints and responses are subject to change, so make sure to\nfollow `release\nnotes. `__\n\n--------------\n\nInstallation\n~~~~~~~~~~~~\n\n.. code:: bash\n\n pip install vss-python-api\n\nUse\n~~~\n\n.. code:: python\n\n from vss_python_api import ApiDeclarations\n vss_api_instance = ApiDeclarations(url, key, secret)\n status_code, response (optional) = vss_api_instance.{function(params)}\n\nFunction list\n~~~~~~~~~~~~~\n\nDevice\n^^^^^^\n\nretrieve a device\n'''''''''''''''''\n\n``get_device(uuid)``\n\n- params: uuid *string*\n- returns: status code *int*, response *json*\n\nupdate a device\n'''''''''''''''\n\n``update_device(uuid, device_object)``\n\n- params: uuid *string*, device\\_object *json*\n- returns: status code *int*\n\ndelete a device\n'''''''''''''''\n\n``delete_device(uuid)``\n\n- params: uuid *string*\n- returns: status code *int*, response *json*\n\n--------------\n\nDevice collection\n^^^^^^^^^^^^^^^^^\n\nlist all devices\n''''''''''''''''\n\n``get_all_devices()``\n\n- params: /\n- returns: status code *int*, response *json*\n\nupdate a list of devices\n''''''''''''''''''''''''\n\n``update_all_devices(device_object_list)``\n\n- params: device\\_object\\_list *json list*\n\n - example:\n ``device_object_list = [device_object1, device_object2, ... device_objectN]``\n\n- returns: status code *int*\n\n--------------\n\nDevice configuration\n^^^^^^^^^^^^^^^^^^^^\n\nget configuration list\n''''''''''''''''''''''\n\n``get_device_config_list(uuid)``\n\n- params: uuid *string*\n- returns: status code *int*, response *json*\n\nget configuration\n'''''''''''''''''\n\n``get_device_config(uuid, tclv_type)``\n\n- params: uuid *string*, tclv\\_type *int*\n- returns: status code *int*, response *json*\n\nset configuration\n'''''''''''''''''\n\n``update_device_config(uuid, tclv_type, value)``\n\n- params: uuid *string*, tclv\\_type *int*, value *int*\n- returns: status code *int*\n\n--------------\n\nReboot\n^^^^^^\n\nreboot device\n'''''''''''''\n\n``reboot_device(uuid)``\n\n- params: uuid *string*\n- returns: status code *int*\n\nreboot a list of devices\n''''''''''''''''''''''''\n\n``reboot_device_list(uuid_list)``\n\n- params: uuid\\_list *list*\n\n - example: ``uuid_list = [uuid1, uuid2, ... uuidN]``\n\n- returns: status code *int*\n\n--------------\n\nSessions\n^^^^^^^^\n\nretrieve a session\n''''''''''''''''''\n\n``get_session(uuid)``\n\n- params: uuid *string*\n- returns: status code *int*, response *json*\n\nupdate a session\n''''''''''''''''\n\n``update_session(uuid, session_object)``\n\n- params: uuid *string*, session\\_object *json*\n- returns: status\\_code *int*\n\nremove a session\n''''''''''''''''\n\n``delete_session(uuid)``\n\n- params: uuid *string*\n- returns: status\\_code *int*\n\n--------------\n\nSession collection\n^^^^^^^^^^^^^^^^^^\n\nlist all sessions\n'''''''''''''''''\n\n``get_session_list()``\n\n- returns: status\\_code *int*, response *json*\n\ncreate a session\n''''''''''''''''\n\n``create_session(session_object)``\n\n- params: session\\_object *json*\n\n - example:\n\n .. code:: python\n\n session_object = {\n \"Uuid\": {uuid},\n \"Backend\": {\n \"Name\": \"HTML\",\n \"Fields\": {\n \"url\": \"http://demo.visionect.com/clock/?t=602\"\n }\n },\n \"Options\": {\n \"DefaultDithering\": \"none\",\n \"DefaultEncoding\": \"4\"\n }\n }\n\n- returns: status\\_code *int*\n\nupdate a list of sessions\n'''''''''''''''''''''''''\n\n``update_session_list(sessions_object)``\n\n- params: sessions\\_object *json list*\n\n - example:\n ``sessions_object = [session_object1, session_object2, ... session_objectN]``\n\n- returns: status\\_code *int*\n\n--------------\n\nRestart\n^^^^^^^\n\nrestart a session\n'''''''''''''''''\n\n``restart_session(uuid)``\n\n- params: uuid *string*\n- returns: status\\_code *int*\n\nrestart a list of sessions\n''''''''''''''''''''''''''\n\n``restart_session_list(uuid_list)``\n\n- params: uuid\\_list *string list*\n\n - example: ``[uuid1, uuid2, ... uuidN]``\n\n- returns: status\\_code *int*\n\n--------------\n\nUser\n^^^^\n\nretrieve a user\n'''''''''''''''\n\n``get_user(username)``\n\n- params: username *string*\n- returns: status\\_code *int*, response *json*\n\nupdate a user\n'''''''''''''\n\n``update_user(username, user_object)``\n\n- params: username *string*, user\\_object *json*\n\n - example:\n\n .. code:: python\n\n {\n \"Username\": {username},\n \"Password\": {password},\n \"IsActive\": true,\n \"IsAPI\": false\n }\n\n- returns: status\\_code *int*\n\ndelete a user\n'''''''''''''\n\n``delete_user(username)``\n\n- params: username *string*\n- returns: status\\_code *int*\n\n--------------\n\nUser list\n^^^^^^^^^\n\nlist all users\n''''''''''''''\n\n``get_user_list()``\n\n- returns: status\\_code *int*, response *json*\n\ncreate a user\n^^^^^^^^^^^^^\n\n``create_user(username, password)``\n\n- params: username *string*, password *string*\n- returns: status\\_code *int*\n\nupdate a list of users\n^^^^^^^^^^^^^^^^^^^^^^\n\n``update_user_list(user_list_object)``\n\n- params: user\\_list\\_object *json list*\n\n - example:\n ``user_list_object = [user_object1, user_object2, ... user_objectN]``\n\n- returns: status\\_code *int*\n\n--------------\n\nConfig\n^^^^^^\n\nretrieve configuration\n''''''''''''''''''''''\n\n``get_config()``\n\n- returns: status\\_code *int*, response *json*\n\nupdate configuration\n^^^^^^^^^^^^^^^^^^^^\n\n``update_config(config_object)``\n\n- params: config\\_object *json*\n- returns: status\\_code *int*\n\n--------------\n\nLive view\n^^^^^^^^^\n\n``get_live_view(uuid, type, file_lv)``\n\n- params: uuid *string*, type *string*, file\\_lv *string*\n\n - example: ``get_live_view({uuid}, 'image', '.png')``\n\n- returns: status\\_code *int*\n\n--------------\n\nStatus\n^^^^^^\n\n``get_status()``\n\n- returns: status\\_code *int*, response *json*\n\n--------------\n\nDevice status\n^^^^^^^^^^^^^\n\n``get_device_status(uuid, start, end, group)``\n\n- params: uuid *string*, start *string*, end *string*, group *string*\n\n - example:\n ``get_device_status(uuid, '1515153600', '1515412800', 'true')``\n\n- returns: status\\_code *int*, response *json*\n\n--------------\n\nHTTP Backend\n^^^^^^^^^^^^\n\nUpload an image to the device via HTTP backend. Make sure device's\nbackend is set to the HTTP.\n\n``set_http(uuid, img)``\n\n- params: uuid *string*, img *file*\n\n - example:\n\n .. code:: python\n\n img = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'img.png')\n fr = {'image': ('img.png', open(img, 'rb'), 'image/png', {'Expires': '0'})}\n sc = my_api.set_http(uuid, fr)\n\n- returns: status\\_code *int*\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://api.visionect.com/", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "vss-python-api", "package_url": "https://pypi.org/project/vss-python-api/", "platform": "", "project_url": "https://pypi.org/project/vss-python-api/", "project_urls": { "Homepage": "https://api.visionect.com/" }, "release_url": "https://pypi.org/project/vss-python-api/0.9.7/", "requires_dist": [ "requests", "requests-toolbelt" ], "requires_python": ">=2.7, >=3.5", "summary": "Python library for easy access to Visionect API.", "version": "0.9.7" }, "last_serial": 3706394, "releases": { "0.9.0": [ { "comment_text": "", "digests": { "md5": "4e683d83fd9c4fe87caea2e66c34318f", "sha256": "6736479b517d1d5b3939dfc95f5853ae81664dcc82c8ac8faece8637bb7b987b" }, "downloads": -1, "filename": "vss_python_api-0.9.0-py2-none-any.whl", "has_sig": false, "md5_digest": "4e683d83fd9c4fe87caea2e66c34318f", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6457, "upload_time": "2018-01-05T13:16:34", "url": "https://files.pythonhosted.org/packages/41/52/87b52bde83f53859b84c1d85ebc168bc8159ffda9bf280e7f4bd5fad7fe2/vss_python_api-0.9.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c2ad4992c9892b88abfce89db7e67cde", "sha256": "7eb0973effa658ab452adeb9747934a86af52a5fe736b0e4bac559d973d7858e" }, "downloads": -1, "filename": "vss_python_api-0.9.0.tar.gz", "has_sig": false, "md5_digest": "c2ad4992c9892b88abfce89db7e67cde", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4697, "upload_time": "2018-01-05T13:16:36", "url": "https://files.pythonhosted.org/packages/7c/57/f788346d791b0c2b95ed8095010058064e01a582e279eea3ec00acd8a4f6/vss_python_api-0.9.0.tar.gz" } ], "0.9.1": [ { "comment_text": "", "digests": { "md5": "4cd6abd1f7d3b28aeb38c9e94fe6c2e2", "sha256": "89ad31d1da670a4dc4d189070a8edc4285a56fe07163c37542ca551621ef8fd1" }, "downloads": -1, "filename": "vss_python_api-0.9.1-py2-none-any.whl", "has_sig": false, "md5_digest": "4cd6abd1f7d3b28aeb38c9e94fe6c2e2", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6551, "upload_time": "2018-01-05T13:19:32", "url": "https://files.pythonhosted.org/packages/1c/fb/b22268fef63d480145cd452f92b368f735e67c347195301099658b712a3a/vss_python_api-0.9.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d34afb55df2d78e87e97020d7b33ff5b", "sha256": "62cee436562792cb88a763f17fe54d6de41674b467d0671855de738555f83bac" }, "downloads": -1, "filename": "vss_python_api-0.9.1.tar.gz", "has_sig": false, "md5_digest": "d34afb55df2d78e87e97020d7b33ff5b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4652, "upload_time": "2018-01-05T13:19:34", "url": "https://files.pythonhosted.org/packages/d8/67/a1002064b17748ad9638569a1e9167ae059d3a880d066c934f6e1d03a21e/vss_python_api-0.9.1.tar.gz" } ], "0.9.2": [ { "comment_text": "", "digests": { "md5": "c5e8ec819cb6530218b0757d7a06fd7a", "sha256": "c8105163c4e2bb5c39814e2b1fd35b9e9512dc89f561263427475d03b0acbe27" }, "downloads": -1, "filename": "vss_python_api-0.9.2-py2-none-any.whl", "has_sig": false, "md5_digest": "c5e8ec819cb6530218b0757d7a06fd7a", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6619, "upload_time": "2018-01-09T16:18:30", "url": "https://files.pythonhosted.org/packages/be/4b/21e08b4e1bcc6a8427b9737ad5618049b2cd6ee3698254a215ace6055d4b/vss_python_api-0.9.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bb13ee72249e99c54349eb29901cb9f0", "sha256": "7f13a1040fa32046b094d6c6fd1296c45d07d737d3f7640a0d6d1231ed578e67" }, "downloads": -1, "filename": "vss_python_api-0.9.2.tar.gz", "has_sig": false, "md5_digest": "bb13ee72249e99c54349eb29901cb9f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4716, "upload_time": "2018-01-09T16:18:31", "url": "https://files.pythonhosted.org/packages/5e/37/72bd6cca5ec08b622116e5d3b66add3cd3023766db7f4faff3dc2dcda713/vss_python_api-0.9.2.tar.gz" } ], "0.9.3": [ { "comment_text": "", "digests": { "md5": "c4dca157b15edddca17d0e2e77a1d1cb", "sha256": "835c5c88d4639f6d4ee80990afe7902b3ec77e0d76bb0143d43306be19bffa69" }, "downloads": -1, "filename": "vss_python_api-0.9.3-py2-none-any.whl", "has_sig": false, "md5_digest": "c4dca157b15edddca17d0e2e77a1d1cb", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6743, "upload_time": "2018-01-10T08:14:57", "url": "https://files.pythonhosted.org/packages/b4/45/ae9a511c292733aaee2a56f1f09f12c426fc6f7111a2a05072d720ebc271/vss_python_api-0.9.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b3ea7293d2fd5311a336fb34daf05dad", "sha256": "fc681ea11ea19bb2e983618f0ce0741c135bc8bee638028791353bf2729aeff1" }, "downloads": -1, "filename": "vss_python_api-0.9.3.tar.gz", "has_sig": false, "md5_digest": "b3ea7293d2fd5311a336fb34daf05dad", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4776, "upload_time": "2018-01-10T08:14:58", "url": "https://files.pythonhosted.org/packages/58/75/f8e0587103d36171d9e1c3c72c5aab5f4641c359b3886a161d986233aec3/vss_python_api-0.9.3.tar.gz" } ], "0.9.4": [ { "comment_text": "", "digests": { "md5": "99ce9632042d2676899218b183580d97", "sha256": "1eb0f3a9f96c2db7c4ecad72391c897d0e17e6e759791ce7aae5660c161d5726" }, "downloads": -1, "filename": "vss_python_api-0.9.4-py2-none-any.whl", "has_sig": false, "md5_digest": "99ce9632042d2676899218b183580d97", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6738, "upload_time": "2018-01-10T09:35:35", "url": "https://files.pythonhosted.org/packages/2e/98/3640c5d8e5767e5f5d2acf00b5ac4787ebe9321496e17ff300262fe1e102/vss_python_api-0.9.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7b3db5a38ae0b79e31d869c7c750894c", "sha256": "807c1bd2292f181209deb827b7caca4276403dab31a25518ea5434a79946c0ec" }, "downloads": -1, "filename": "vss_python_api-0.9.4.tar.gz", "has_sig": false, "md5_digest": "7b3db5a38ae0b79e31d869c7c750894c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4766, "upload_time": "2018-01-10T09:35:36", "url": "https://files.pythonhosted.org/packages/7f/f0/33e77da58895f76346e65847ebabb41d0ca9d1f062bdbeb38e2f6296751b/vss_python_api-0.9.4.tar.gz" } ], "0.9.5": [ { "comment_text": "", "digests": { "md5": "9daa4b1576c91dbb47e764b302cb7c60", "sha256": "266e018a27c65eda2265dec574ee5bf6912cf98594ab58921e7cfcbfbceaee86" }, "downloads": -1, "filename": "vss_python_api-0.9.5-py2-none-any.whl", "has_sig": false, "md5_digest": "9daa4b1576c91dbb47e764b302cb7c60", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6743, "upload_time": "2018-01-15T12:32:37", "url": "https://files.pythonhosted.org/packages/95/ee/1fcd04a9d3d2b44449df1c90cf6a68a143ae74ed2af66e23623481f6f8ef/vss_python_api-0.9.5-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "40998703b579ab00930a66f5c3b0f5b7", "sha256": "3130e92af62a2cc868029a097b61313f67f99d3b5fba34dadb66b78424690cc2" }, "downloads": -1, "filename": "vss_python_api-0.9.5.tar.gz", "has_sig": false, "md5_digest": "40998703b579ab00930a66f5c3b0f5b7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4784, "upload_time": "2018-01-15T12:32:41", "url": "https://files.pythonhosted.org/packages/d1/0c/4b6d457aace3c333f0d6f1fec44c87556ca2346158addc7b666c08811551/vss_python_api-0.9.5.tar.gz" } ], "0.9.6": [ { "comment_text": "", "digests": { "md5": "5dd73f3256aaadfccd99acd9dd5b3ced", "sha256": "713a05ab1ee244565f6e37b2bca204958482e5f0f5e0f47241ed65e4eaf886ed" }, "downloads": -1, "filename": "vss_python_api-0.9.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5dd73f3256aaadfccd99acd9dd5b3ced", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7, >=3.5", "size": 7239, "upload_time": "2018-03-26T12:54:14", "url": "https://files.pythonhosted.org/packages/66/7e/b8a170f994a98af9e4acfe18ea3b8d91b5b617bd94458a7d4c76ed5fccd9/vss_python_api-0.9.6-py2.py3-none-any.whl" } ], "0.9.7": [ { "comment_text": "", "digests": { "md5": "567290238cd7f0a6750eece39a081bb0", "sha256": "aec9e5089b330d47a49064da1223e6aad7c9540b639b1db36e128e1a7a942ee1" }, "downloads": -1, "filename": "vss_python_api-0.9.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "567290238cd7f0a6750eece39a081bb0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7, >=3.5", "size": 7242, "upload_time": "2018-03-26T12:58:31", "url": "https://files.pythonhosted.org/packages/84/d0/08b0499b4793ae90311b2e1ac410dc6daafbbfa939c55e480b9a7de250e9/vss_python_api-0.9.7-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "567290238cd7f0a6750eece39a081bb0", "sha256": "aec9e5089b330d47a49064da1223e6aad7c9540b639b1db36e128e1a7a942ee1" }, "downloads": -1, "filename": "vss_python_api-0.9.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "567290238cd7f0a6750eece39a081bb0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7, >=3.5", "size": 7242, "upload_time": "2018-03-26T12:58:31", "url": "https://files.pythonhosted.org/packages/84/d0/08b0499b4793ae90311b2e1ac410dc6daafbbfa939c55e480b9a7de250e9/vss_python_api-0.9.7-py2.py3-none-any.whl" } ] }