{ "info": { "author": "Alexandr Sapunji", "author_email": "alexandr.sapunji@inmation.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "![inmation header](http://www.inmation.com/images/inmation_github_header.png \"inmation\")\n\n# inmation API Client\nThis API client can only be used with the new inmation Web API server.\n\n## Install\nInstall with `pip install inmation-api-client`.\n\n## Dependencies\n* [websockets](https://github.com/aaugustin/websockets), will be installed automatically when installing with `pip`.\n\n## Documentation\n\nVisit the [api client documentation](https://inmation.com/docs/python-api-client/latest/index.html) page on the inmation's docs website for various usage examples and more.\n\n## How to use it\n\n### Advanced authentication options\n\n- authority can be inmation, ad (Active Directory - domain account), machine (local account)\n\n- username can provided in 'User Principal Name' or 'Down-Level Logon Name'\n\nsource: [https://docs.microsoft.com/en-us/windows/desktop/secauthn/user-name-formats](https://docs.microsoft.com/en-us/windows/desktop/secauthn/user-name-formats)\n\n`auth` authentication and `authorization` fields:\n\n```json\noptions = {\n 'auth': {\n 'username': '',\n 'password': '',\n 'authority': 'inmation | ad | machine',\n 'grant_type': 'password',\n 'include_claims': ['email', 'family_name', 'given_name', 'middle_name', 'phone_number']\n },\n 'authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...'\n}\n```\n\n`include_claims` can only be used in combination with authority set to ad. The token will not be returned\nto the client but passed via the req argument into `ExecFunction` implementation.\n\nNote: check Web API version which `authorization` options its supports.\n\nExample Active Directory authentication:\n\n```json\noptions = {\n 'auth': {\n 'username': 'user@domain.com',\n 'password': 'secret',\n 'authority': 'ad',\n 'grant_type': 'password'\n }\n}\n```\n\nExample Bearer token authentication:\n\n```json\noptions = {\n 'authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...'\n}\n```\n\nExample Basic authentication:\n\n```json\noptions = {\n 'authorization': 'Basic dXNlcm5hbWU6cGFzc3dvcmQ='\n}\n```\n\n### Connect and Read example\n\n```python\nfrom inmation_api_client import Client, Options, Item\n\n\ndef create_client():\n options = Options({\n 'auth': {\n 'username': 'user@domain.com',\n 'password': 'secret',\n 'authority': 'ad',\n 'grant_type': 'password'\n }\n })\n client = Client()\n client.Connect('127.0.0.1', 8002, options)\n\n def connection_changed(conn_info):\n print('Connection state: {}, authenticated: {}'.format(conn_info.state_string, conn_info.authenticated))\n client.OnConnectionChanged(connection_changed)\n\n def on_error(err):\n if err:\n print(\"Error: {}\".format(err.message))\n client.OnError(on_error)\n\n return client\n\n\ndef main():\n items_path = \"/System/Core/\"\n\n # Make sure you have some items with historical data\n items = [Item(items_path + i) for i in ['Item01', 'Item02', 'Item03']]\n client = create_client()\n\n # Read values syncroniously\n response = client.Read(items)\n print(response['data'])\n\n\nif __name__ == '__main__':\n main()\n```\n\n# inmation\n\ninmation is a vendor-independent industrial system-integration specialist. Dedicated to modern technologies such as OPC UA (Unified Architecture) and document-oriented schema-less repositories, inmation opens up new horizons for enterprise real-time data management.\n\nMore information on [inmation.com](https://inmation.com)\n\n## License\n\nMIT", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://inmation.com", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "inmation-api-client", "package_url": "https://pypi.org/project/inmation-api-client/", "platform": "", "project_url": "https://pypi.org/project/inmation-api-client/", "project_urls": { "Homepage": "https://inmation.com" }, "release_url": "https://pypi.org/project/inmation-api-client/0.7.5/", "requires_dist": null, "requires_python": ">=3.6", "summary": "API client for system:inmation.", "version": "0.7.5" }, "last_serial": 5617898, "releases": { "0.1.8": [ { "comment_text": "", "digests": { "md5": "59f639be8bfdf558cf06efc202dd065c", "sha256": "455a5c9e5f1cfcc2932dd0543254cb99fecbee4809bd51aa9a71b8ca1accf3dd" }, "downloads": -1, "filename": "inmation_api_client-0.1.8-py3-none-any.whl", "has_sig": false, "md5_digest": "59f639be8bfdf558cf06efc202dd065c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 30712, "upload_time": "2018-07-11T11:17:12", "url": "https://files.pythonhosted.org/packages/23/0b/d8d811edcf32f44782d3fbb53174fee89ecea631901eb251a9df71d6334f/inmation_api_client-0.1.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0622edd2457729ae2560951c022295f0", "sha256": "f720163c8fe56af0932f226e1af94c98f9080aa5ef6dc5a89ebfb6cb7377a10d" }, "downloads": -1, "filename": "inmation-api-client-0.1.8.tar.gz", "has_sig": false, "md5_digest": "0622edd2457729ae2560951c022295f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19563, "upload_time": "2018-07-11T11:17:14", "url": "https://files.pythonhosted.org/packages/cb/42/5f3999dc7652faaaf2bf0594dc5f76b6eeda49144daa00b8ca4b95b452d7/inmation-api-client-0.1.8.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "a2fd87aeedcfeddca5912d8074bed3ea", "sha256": "1255b0ab32f2791039af193fcd7227132666b67bac72e45a83ef5e795b904114" }, "downloads": -1, "filename": "inmation_api_client-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "a2fd87aeedcfeddca5912d8074bed3ea", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 31189, "upload_time": "2018-09-11T13:44:38", "url": "https://files.pythonhosted.org/packages/f1/3a/3a58dacd3e0b1a7fe67a3eebcf6c6a57480040f15fa7a0ac6dd1354f9d68/inmation_api_client-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "73f66b7f368ac3be58ab7b2a701e0a43", "sha256": "50eb2dd5ffefbb1f919ea6d0b5e711b79c45f2e6e625c787447d732079a1fe66" }, "downloads": -1, "filename": "inmation-api-client-0.2.0.tar.gz", "has_sig": false, "md5_digest": "73f66b7f368ac3be58ab7b2a701e0a43", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19699, "upload_time": "2018-09-11T13:44:41", "url": "https://files.pythonhosted.org/packages/b2/73/9003c9397703c55925e4e99a587d745fc48db07cbe4be4147564a9c8ea8a/inmation-api-client-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "6310b8512aeff67b01a394c1191f5af8", "sha256": "f78c0c29bb9ddf35f45439d9348fc445d0dafa1ab54faeb1b76f97cca4450cd7" }, "downloads": -1, "filename": "inmation_api_client-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "6310b8512aeff67b01a394c1191f5af8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 31187, "upload_time": "2018-09-11T14:20:05", "url": "https://files.pythonhosted.org/packages/fb/0e/b823046fc77a10757af3a033dd2231c184306150bac76e094d4855a90bf5/inmation_api_client-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e03c23ba328bd60b96e4dfece1baa5f7", "sha256": "2855f6430af3d6a9857653cbec5c02b1459085aaf9169379ca4a837cfc3815d1" }, "downloads": -1, "filename": "inmation-api-client-0.2.1.tar.gz", "has_sig": false, "md5_digest": "e03c23ba328bd60b96e4dfece1baa5f7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19697, "upload_time": "2018-09-11T14:20:07", "url": "https://files.pythonhosted.org/packages/19/b2/7d7fb147eb8278be9d783af330ee9b9bfd5ecea81acf7917552b1ebf584a/inmation-api-client-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "7432668282077066afbf670b459a2d38", "sha256": "1b65577b2e8b9ce5750773779fa0dda02e0ab4d1d2bbafb612f2d5322e2f60f2" }, "downloads": -1, "filename": "inmation-api-client-0.2.2.tar.gz", "has_sig": false, "md5_digest": "7432668282077066afbf670b459a2d38", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21292, "upload_time": "2018-11-02T14:38:06", "url": "https://files.pythonhosted.org/packages/20/72/0aec78c3ae2c0714a8575f312accdb73bf140dc9b60a4279d5215137c46a/inmation-api-client-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "ac12e97fcac20cd1f3c8604c10d5c9e1", "sha256": "29bdd31053b23b828517d9c3f20d135dbf3bcc938920a23712e2ac4cff589ef9" }, "downloads": -1, "filename": "inmation-api-client-0.2.3.tar.gz", "has_sig": false, "md5_digest": "ac12e97fcac20cd1f3c8604c10d5c9e1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21336, "upload_time": "2018-11-02T15:58:18", "url": "https://files.pythonhosted.org/packages/d1/5e/c4d5f5dcbb2098ed527219ab8b11debeca84033ef608c8ad415ed543396b/inmation-api-client-0.2.3.tar.gz" } ], "0.7.1": [ { "comment_text": "", "digests": { "md5": "a0e53dea8ff1dd6141b62874472fa2c9", "sha256": "de00beaa174dfdc2ab411999fa236eb1e1bfb9fb0ae72dccba7290cc53506112" }, "downloads": -1, "filename": "inmation-api-client-0.7.1.tar.gz", "has_sig": false, "md5_digest": "a0e53dea8ff1dd6141b62874472fa2c9", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 24026, "upload_time": "2019-06-12T07:35:07", "url": "https://files.pythonhosted.org/packages/0d/e1/4d3c3f4814ae9878d420e26abf1b1cbb714b16ec622e4f277923941dca0e/inmation-api-client-0.7.1.tar.gz" } ], "0.7.3": [ { "comment_text": "", "digests": { "md5": "b5cf5b09831417b85c3132824f6d086c", "sha256": "56ab6d9ce5dfafd0bfcec87c4732f1c2bab6303a15e6ed09ae3ef049583ba570" }, "downloads": -1, "filename": "inmation-api-client-0.7.3.tar.gz", "has_sig": false, "md5_digest": "b5cf5b09831417b85c3132824f6d086c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 24541, "upload_time": "2019-06-12T14:25:16", "url": "https://files.pythonhosted.org/packages/ef/95/b99c303a58ab4f160854148fef933dac2f54c731bc5656ecfe37cebc835a/inmation-api-client-0.7.3.tar.gz" } ], "0.7.5": [ { "comment_text": "", "digests": { "md5": "e25e7ed753bd2d20a50e2e5f2558733a", "sha256": "970f4674464ca0dd798af55e4bcd67be3bb4bbd8948763c3ad94488f04c1154f" }, "downloads": -1, "filename": "inmation-api-client-0.7.5.tar.gz", "has_sig": false, "md5_digest": "e25e7ed753bd2d20a50e2e5f2558733a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 22412, "upload_time": "2019-08-01T10:10:32", "url": "https://files.pythonhosted.org/packages/74/0e/90e5c606bd4f81bd6c2bd51ccc5755905c7901b146be795fe23d6544f855/inmation-api-client-0.7.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e25e7ed753bd2d20a50e2e5f2558733a", "sha256": "970f4674464ca0dd798af55e4bcd67be3bb4bbd8948763c3ad94488f04c1154f" }, "downloads": -1, "filename": "inmation-api-client-0.7.5.tar.gz", "has_sig": false, "md5_digest": "e25e7ed753bd2d20a50e2e5f2558733a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 22412, "upload_time": "2019-08-01T10:10:32", "url": "https://files.pythonhosted.org/packages/74/0e/90e5c606bd4f81bd6c2bd51ccc5755905c7901b146be795fe23d6544f855/inmation-api-client-0.7.5.tar.gz" } ] }