| Name | energy_assistant JSON |
| Version |
0.1.19
JSON |
| download |
| home_page | None |
| Summary | Energy Assistant |
| upload_time | 2024-12-28 21:08:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 2024 Paul Frank 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 |
energy assistant
home assistant
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Energy Assistant
Energy Assistant is a free, opensource Energy Management System which works together with [Home Assistant](https://www.home-assistant.io/) and [Evcc](https://evcc.io/).
Energy Assistant is using [Emhass](https://emhass.readthedocs.io/en/latest/) in order to optimize the energy consumption of your house.
**Documentation and support**
For issues, please go to [the issue tracker](https://github.com/pail23/energy-assistant-backend/issues).
For feature requests, please see [feature requests](https://github.com/pail23/energy-assistant-backend/discussions/categories/feature-requests-and-ideas).
## Running the Energy Assistant
### Preferred method: Home Assistant Add-on
By far the most convenient way to run the Energy Assistant is to install the Energy Assistant Add-on:
1. Add the Energy Assistant repository to your Home Assistant instance.
2. Install the Energy Assistant add-on.
[![Add repository on my Home Assistant][repository-badge]][repository-url]
### Alternative method: Docker image
An alternative way to run the Energy Assistant is by running the docker image:
Copy the `energy_assistant.yaml.dist` file to `energy_assistant.yaml` and modify it to match your setup and then start the docker container in the same folder.
```
docker run --name em -p 8080:5000 -v "$(pwd)/energy_assistant.yaml:/config/energy_assistant.yaml" ghcr.io/pail23/energy-assistant-server:latest
```
## Configure Energy Assistant
Please find information on how to configure Energy Assistant [here](https://pail23.github.io/energy-assistant-backend/config_file.html).
## User documentation
Please consult the user documentation for [Energy Assistant](https://pail23.github.io/energy-assistant-backend/).
[repository-badge]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg
[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fpail23%2Fenergy-assistant-addon
## Local Development
The easiest way to get started with development is to use Visual Studio Code with devcontainers. This approach will create a preconfigured development environment with all the tools you need. This approach is enabled for the Energy Assistant frontend and the Energy Assistant backend repository. [Learn more about devcontainers](https://code.visualstudio.com/docs/devcontainers/containers).
Getting started:
1. Go to [Energy Assistant backend](https://github.com/pail23/energy-assistant-backend) repository and click "fork".
2. Clone the forked repository locally (git clone ...)
3. Open the devcontainer in VSCode
4. Copy `energy_assistan.yaml.dist` to `energy_assistan.yaml` and configure your setup (e.g. connection to Home Assistant)
5. Press F5 to start Energy Assistant
6. Go to [Energy Assistant frontend](https://github.com/pail23/energy-assistant-frontend) repository and click "fork".
7. Clone the forked repository locally (git clone ...)
8. Open the devcontainer in VSCode
9. Enter `yarn install` and then `yarn dev` in the Terminal of VSCode
Useful commands:
`./scripts/lint.sh` run the linter to check the code quality.
`./scripts/create-dev-db.sh` create a new database in the root folder of the project.
Raw data
{
"_id": null,
"home_page": null,
"name": "energy_assistant",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "energy assistant, home assistant",
"author": null,
"author_email": "The Energy Assistant Creators <pail23@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/74/ed/887878caa3b51139c542eb1a921f7226e8c4de27ef872f1ad22b24f8c9c5/energy_assistant-0.1.19.tar.gz",
"platform": null,
"description": "# Energy Assistant\n\nEnergy Assistant is a free, opensource Energy Management System which works together with [Home Assistant](https://www.home-assistant.io/) and [Evcc](https://evcc.io/).\n\nEnergy Assistant is using [Emhass](https://emhass.readthedocs.io/en/latest/) in order to optimize the energy consumption of your house.\n\n**Documentation and support**\n\nFor issues, please go to [the issue tracker](https://github.com/pail23/energy-assistant-backend/issues).\n\nFor feature requests, please see [feature requests](https://github.com/pail23/energy-assistant-backend/discussions/categories/feature-requests-and-ideas).\n\n## Running the Energy Assistant\n\n### Preferred method: Home Assistant Add-on\n\nBy far the most convenient way to run the Energy Assistant is to install the Energy Assistant Add-on:\n\n1. Add the Energy Assistant repository to your Home Assistant instance.\n2. Install the Energy Assistant add-on.\n\n[![Add repository on my Home Assistant][repository-badge]][repository-url]\n\n### Alternative method: Docker image\n\nAn alternative way to run the Energy Assistant is by running the docker image:\n\nCopy the `energy_assistant.yaml.dist` file to `energy_assistant.yaml` and modify it to match your setup and then start the docker container in the same folder.\n\n```\ndocker run --name em -p 8080:5000 -v \"$(pwd)/energy_assistant.yaml:/config/energy_assistant.yaml\" ghcr.io/pail23/energy-assistant-server:latest\n```\n\n## Configure Energy Assistant\n\nPlease find information on how to configure Energy Assistant [here](https://pail23.github.io/energy-assistant-backend/config_file.html).\n\n## User documentation\n\nPlease consult the user documentation for [Energy Assistant](https://pail23.github.io/energy-assistant-backend/).\n\n[repository-badge]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg\n[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fpail23%2Fenergy-assistant-addon\n\n## Local Development\n\nThe easiest way to get started with development is to use Visual Studio Code with devcontainers. This approach will create a preconfigured development environment with all the tools you need. This approach is enabled for the Energy Assistant frontend and the Energy Assistant backend repository. [Learn more about devcontainers](https://code.visualstudio.com/docs/devcontainers/containers).\n\nGetting started:\n\n1. Go to [Energy Assistant backend](https://github.com/pail23/energy-assistant-backend) repository and click \"fork\".\n2. Clone the forked repository locally (git clone ...)\n3. Open the devcontainer in VSCode\n4. Copy `energy_assistan.yaml.dist` to `energy_assistan.yaml` and configure your setup (e.g. connection to Home Assistant)\n5. Press F5 to start Energy Assistant\n6. Go to [Energy Assistant frontend](https://github.com/pail23/energy-assistant-frontend) repository and click \"fork\".\n7. Clone the forked repository locally (git clone ...)\n8. Open the devcontainer in VSCode\n9. Enter `yarn install` and then `yarn dev` in the Terminal of VSCode\n\nUseful commands:\n\n`./scripts/lint.sh` run the linter to check the code quality.\n\n`./scripts/create-dev-db.sh` create a new database in the root folder of the project.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Paul Frank 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.",
"summary": "Energy Assistant",
"version": "0.1.19",
"project_urls": {
"Homepage": "https://github.com/pail23/energy-assistant-backend"
},
"split_keywords": [
"energy assistant",
" home assistant"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f2e2ec68a1a85ca6f7b1f87dfb63dc07ca4938ab6224a5d41251a9d836f44fcf",
"md5": "05ed76beec68a8e7b38f1f270aa0785b",
"sha256": "e9948438622221a63e2ce5f255e8242cafbc909bbf14151c0d616be8fbb26b1d"
},
"downloads": -1,
"filename": "energy_assistant-0.1.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05ed76beec68a8e7b38f1f270aa0785b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 89309,
"upload_time": "2024-12-28T21:08:30",
"upload_time_iso_8601": "2024-12-28T21:08:30.699721Z",
"url": "https://files.pythonhosted.org/packages/f2/e2/ec68a1a85ca6f7b1f87dfb63dc07ca4938ab6224a5d41251a9d836f44fcf/energy_assistant-0.1.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "74ed887878caa3b51139c542eb1a921f7226e8c4de27ef872f1ad22b24f8c9c5",
"md5": "16dc6415f46489001fc7ab263f5e4b03",
"sha256": "3354c143238328687301a725fa6e9745237623e06e0a9d3bafb3459267512154"
},
"downloads": -1,
"filename": "energy_assistant-0.1.19.tar.gz",
"has_sig": false,
"md5_digest": "16dc6415f46489001fc7ab263f5e4b03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 58108,
"upload_time": "2024-12-28T21:08:32",
"upload_time_iso_8601": "2024-12-28T21:08:32.126012Z",
"url": "https://files.pythonhosted.org/packages/74/ed/887878caa3b51139c542eb1a921f7226e8c4de27ef872f1ad22b24f8c9c5/energy_assistant-0.1.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-28 21:08:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pail23",
"github_project": "energy-assistant-backend",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "energy_assistant"
}
