{ "info": { "author": "Christian L\u00f6lkes", "author_email": "christian.loelkes@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# infobeamerhosted\n\n## Quick usage\n\n```\npip install infobeamerhosted\npython -m infobeamerhosted\n```\n\n## API\n\n### Infobeamer()\n\n```\nfrom infobeamerhosted import *\nInfobeamerAPI.KEY = 'your info beamer api key here'\nfoo = Infobeamer()\n```\n\n#### Properties\n\n* ```.devices``` access all devices\n* ```.setups``` access all devices\n* ```.packages``` access all devices\n* ```.assets``` access all devices\n* ```.group : str``` Sets .group for all devices, setups, packages and assets.\n\n### Common Properties for Devices(), Setups(), Packages(), Assets()\n\n* ```.group```: the current group name used to select a subset of items. Set to '' (default) to disable.\n* ```.all```: all items available.\n* ```.selection```: items where the group name matches ```.group```. If this is not set the output is identitcal to ```.all```.\n\n### Common Methods for Devices(), Setups, Packages(), Assets()\n\n* ```getItems()```fetches all items from the Info-Beamer API. This is called upon initialization.\n\n### Common Properties for Device(), Setup(), Package(), Asset()\n\n* *Device()*: all properties from the [Device Object](https://info-beamer.com/doc/api#deviceobject)\n* *Setup()*: all properties from the [Setup Info Object](https://info-beamer.com/doc/api#setupinfoobject)\n* *Package()*: all properties from the [Package Object](https://info-beamer.com/doc/api#packageobject)\n* *Asset()*: all properties from the [Package Object](https://info-beamer.com/doc/api#assetinfoobject)\n* ```.group```: the current group name used to select a subset of items. Set to '' (default) to disable.\n\n### Common Methods for Device(), Setup(), Package(), Asset()\n\n* ```.inGroup(name: str) -> bool``` return True if the Item is in the group with the name *name*.\n* ```.update([option: str, payload: dict]) -> bool```. Returns True if successfull, False otherwise.\n* ```.delete() -> bool``` deletes the item. Returns True if successfull, False otherwise.\n\n### InfobeamerAPI()\n\n#### Static Properties\n\n* ```InfobeamerAPI.KEY```holds our API key (required).\n* ```InfobeamerAPI.USER```holds the username for the API. Default is set to ''.\n* ```InfobeamerAPI.URL```holds the API URL. Default is set to https://info-beamer.com/api/v1/.\n\n## Standalone use\n\n```python -m infobeamerhosted```\n\n### *API Settings*\n* ```--api-key``` Key for info-beamer.com.\n* ```--api-user``` User for info-beamer.com. Default is *empty*. (optional)\n* ```--api-url``` Key from info-beamer.com. Default is **https://info-beamer.com/api/v1/** (optional)\n\nYou can also set environment variables for API_KEY, API_USER (optional), API_URL (optional).\n\n```\nexport API_KEY = \"infobeamer api key\"\nexport API_USER = \"\"\nexport API_URL = \"https://info-beamer.com/api/v1/\"\n```\n\n## Ressources\n\n* **API Documentation** [info-beamer.com/doc/api](https://info-beamer.com/doc/api)\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/zkmkarlsruhe/pypi-infobeamerhosted", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "infobeamerhosted", "package_url": "https://pypi.org/project/infobeamerhosted/", "platform": "", "project_url": "https://pypi.org/project/infobeamerhosted/", "project_urls": { "Homepage": "https://github.com/zkmkarlsruhe/pypi-infobeamerhosted" }, "release_url": "https://pypi.org/project/infobeamerhosted/1.0/", "requires_dist": [ "requests" ], "requires_python": ">=3.5", "summary": "Python wrapper around the Info Beamer Hosted API.", "version": "1.0", "yanked": false, "yanked_reason": null }, "last_serial": 6026628, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "dba013683f1d8dddd775bde2ba3f18dd", "sha256": "2ccc2ed86adaf1290d110c9f95f6dfa8800e6be49be3bdb944285f1cb59cecd3" }, "downloads": -1, "filename": "infobeamerhosted-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "dba013683f1d8dddd775bde2ba3f18dd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 8555, "upload_time": "2019-10-25T00:08:20", "upload_time_iso_8601": "2019-10-25T00:08:20.279962Z", "url": "https://files.pythonhosted.org/packages/95/0c/8b1f201431c8af5afc54dfafea6b51a872736e4b03751adddef5da878671/infobeamerhosted-1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "6ba1262c7a0a581eb46417a0df7572c0", "sha256": "31f3f953172744db09cd95faf198f8b5b5981889fe2f42528091b472f16fc9c8" }, "downloads": -1, "filename": "infobeamerhosted-1.0.tar.gz", "has_sig": false, "md5_digest": "6ba1262c7a0a581eb46417a0df7572c0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 4752, "upload_time": "2019-10-25T00:08:22", "upload_time_iso_8601": "2019-10-25T00:08:22.615341Z", "url": "https://files.pythonhosted.org/packages/8a/8f/7fb6606c3532a4f95a02dbb5225c40eccb4cb3cf7c91fb041be11d3fe5ee/infobeamerhosted-1.0.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "dba013683f1d8dddd775bde2ba3f18dd", "sha256": "2ccc2ed86adaf1290d110c9f95f6dfa8800e6be49be3bdb944285f1cb59cecd3" }, "downloads": -1, "filename": "infobeamerhosted-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "dba013683f1d8dddd775bde2ba3f18dd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 8555, "upload_time": "2019-10-25T00:08:20", "upload_time_iso_8601": "2019-10-25T00:08:20.279962Z", "url": "https://files.pythonhosted.org/packages/95/0c/8b1f201431c8af5afc54dfafea6b51a872736e4b03751adddef5da878671/infobeamerhosted-1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "6ba1262c7a0a581eb46417a0df7572c0", "sha256": "31f3f953172744db09cd95faf198f8b5b5981889fe2f42528091b472f16fc9c8" }, "downloads": -1, "filename": "infobeamerhosted-1.0.tar.gz", "has_sig": false, "md5_digest": "6ba1262c7a0a581eb46417a0df7572c0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 4752, "upload_time": "2019-10-25T00:08:22", "upload_time_iso_8601": "2019-10-25T00:08:22.615341Z", "url": "https://files.pythonhosted.org/packages/8a/8f/7fb6606c3532a4f95a02dbb5225c40eccb4cb3cf7c91fb041be11d3fe5ee/infobeamerhosted-1.0.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }