| Name | carconnectivity-plugin-webui JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | CarConnectivity plugin for a web based user interface |
| upload_time | 2025-02-20 21:10:33 |
| maintainer | None |
| docs_url | None |
| author | Till Steinbach |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2021 Till Steinbach
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CarConnectivity Plugin for A Web based User Interface
[](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/releases/latest)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/blob/master/LICENSE)
[](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/issues)
[](https://pypi.org/project/carconnectivity-plugin-webui/)
[](https://pypi.org/project/carconnectivity-plugin-webui/)
[](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)
[](https://github.com/sponsors/tillsteinbach)
## CarConnectivity will become the successor of [WeConnect-python](https://github.com/tillsteinbach/WeConnect-python) in 2025 with similar functionality but support for other brands beyond Volkswagen!
[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. This plugin allows you to use a browser to interact with CarConnectivity.
<img src="https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-webui/main/screenshots/screenshot1.png" width="300">
## How to install
### Install using PIP
If you want to use CarConnectivity Web UI, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-webui/). Just install instead using:
```bash
pip3 install carconnectivity-plugin-webui
```
after you installed CarConnectivity
## Configuration
In your carconnectivity.json configuration add a section for the webui plugin like this. A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/tree/main/doc/Config.md).
```
{
"carConnectivity": {
"connectors": [
...
]
"plugins": [
{
"type": "webui",
"config": {
"username": "admin", // Admin username for login
"password": "secret" // Admin password for login
}
}
]
}
}
```
## How to use
You will default find the webinterface on http port 4000 on the machine that is hosting carconnectivity. You can change interface with the `host` parameter and the port with the `port parameter`.
Always set your personal username and password to protect your data from theft.
## Updates
If you want to update, the easiest way is:
```bash
pip3 install carconnectivity-plugin-webui --upgrade
```
Raw data
{
"_id": null,
"home_page": null,
"name": "carconnectivity-plugin-webui",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Till Steinbach",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/45/af/985f3c2efcc136e872e7a4151cd97bbc137a71e010e5444d4c534a5be3b0/carconnectivity_plugin_webui-0.1.2.tar.gz",
"platform": null,
"description": "\n\n# CarConnectivity Plugin for A Web based User Interface\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/)\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/releases/latest)\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/blob/master/LICENSE)\n[](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/issues)\n[](https://pypi.org/project/carconnectivity-plugin-webui/)\n[](https://pypi.org/project/carconnectivity-plugin-webui/)\n[](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)\n[](https://github.com/sponsors/tillsteinbach)\n\n## CarConnectivity will become the successor of [WeConnect-python](https://github.com/tillsteinbach/WeConnect-python) in 2025 with similar functionality but support for other brands beyond Volkswagen!\n\n[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. This plugin allows you to use a browser to interact with CarConnectivity.\n\n<img src=\"https://raw.githubusercontent.com/tillsteinbach/CarConnectivity-plugin-webui/main/screenshots/screenshot1.png\" width=\"300\">\n\n## How to install\n\n### Install using PIP\nIf you want to use CarConnectivity Web UI, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-webui/). Just install instead using:\n```bash\npip3 install carconnectivity-plugin-webui\n```\nafter you installed CarConnectivity\n\n## Configuration\nIn your carconnectivity.json configuration add a section for the webui plugin like this. A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-webui/tree/main/doc/Config.md).\n```\n{\n \"carConnectivity\": {\n \"connectors\": [\n ...\n ]\n \"plugins\": [\n {\n \"type\": \"webui\",\n \"config\": {\n \"username\": \"admin\", // Admin username for login\n \"password\": \"secret\" // Admin password for login\n }\n }\n ]\n }\n}\n```\n\n## How to use\nYou will default find the webinterface on http port 4000 on the machine that is hosting carconnectivity. You can change interface with the `host` parameter and the port with the `port parameter`.\nAlways set your personal username and password to protect your data from theft.\n\n## Updates\nIf you want to update, the easiest way is:\n```bash\npip3 install carconnectivity-plugin-webui --upgrade\n```\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2021 Till Steinbach\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "CarConnectivity plugin for a web based user interface",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2e99623f45749bb5d4d9411164afc4b07059441b594e8952bb7e69f9eec18c82",
"md5": "8e077f6f629224c2f46deb94acfc13b7",
"sha256": "dff9a966a0cdfc0cfa9b34dc1067b07321eba0cf900258da332af27a70e1568e"
},
"downloads": -1,
"filename": "carconnectivity_plugin_webui-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e077f6f629224c2f46deb94acfc13b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1997039,
"upload_time": "2025-02-20T21:10:31",
"upload_time_iso_8601": "2025-02-20T21:10:31.599339Z",
"url": "https://files.pythonhosted.org/packages/2e/99/623f45749bb5d4d9411164afc4b07059441b594e8952bb7e69f9eec18c82/carconnectivity_plugin_webui-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "45af985f3c2efcc136e872e7a4151cd97bbc137a71e010e5444d4c534a5be3b0",
"md5": "e5253b766f901b5d676422c863fad660",
"sha256": "d1acb21fed9cf38e0f7fff2624e974c004e598c4956b5fe273072f24e1a448b2"
},
"downloads": -1,
"filename": "carconnectivity_plugin_webui-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "e5253b766f901b5d676422c863fad660",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 2346774,
"upload_time": "2025-02-20T21:10:33",
"upload_time_iso_8601": "2025-02-20T21:10:33.903697Z",
"url": "https://files.pythonhosted.org/packages/45/af/985f3c2efcc136e872e7a4151cd97bbc137a71e010e5444d4c534a5be3b0/carconnectivity_plugin_webui-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-20 21:10:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "carconnectivity-plugin-webui"
}
