# Green Button Objects
This Python code parses an Energy Service Provider Interface
(ESPI), or "Green Button", XML file into Python objects.
Run `parse_feed()` from the `parse.py` file to get a list of `UsagePoint`
objects. From there you should be able to explore all of the data in the
feed. Documentation is a little lacking at the moment, but the class
members mostly match the names from the ESPI standard (or at least the XML
entities).
There's a bit of documentation in the `doc` directory about the ESPI
standard, mostly figured out from public sources and actual ESPI files.
Forked from the original repository [greenbutton-objects](https://github.com/asciipip/greenbutton-python)
and packaged to be published on PyPI.
Used by the Code for Boston [Home Energy Analysis Tool](https://github.com/codeforboston/home-energy-analysis-tool).
## Development
Simple steps for development setup:
1. Clone the git repository.
3. Navigate to any directory and create a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments) and activate it
4. The following commands can be run from inside the top-level greenbutton_objects folder while the virtual environment is active
2. `pip install -e .` builds the [python egg](https://stackoverflow.com/questions/2051192/what-is-a-python-egg) for greenbutton_objects and then installs greenbutton_objects
3. `pip install -r requirements-dev.txt` which installs the libraries required to develop greenbutton_objects
Then, you should be able to run `pytest`, also from any directory, and see the test run successfully.
Raw data
{
"_id": null,
"home_page": null,
"name": "greenbutton-objects",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": "feed, reader, tutorial",
"author": null,
"author_email": "Phil Gold <phil_g@pobox.com>, Adam Finkle <77808710+AdamFinkle@users.noreply.github.com>, Ethan Strominger <ethanstrominger2@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/98/99/6c4603cd1482fbe07f9856bd798b5d2fbd838fa4d322c1f5167c47579c72/greenbutton_objects-2024.7.11.tar.gz",
"platform": null,
"description": "# Green Button Objects\n\nThis Python code parses an Energy Service Provider Interface\n(ESPI), or \"Green Button\", XML file into Python objects.\n\nRun `parse_feed()` from the `parse.py` file to get a list of `UsagePoint`\nobjects. From there you should be able to explore all of the data in the\nfeed. Documentation is a little lacking at the moment, but the class\nmembers mostly match the names from the ESPI standard (or at least the XML\nentities).\n\nThere's a bit of documentation in the `doc` directory about the ESPI\nstandard, mostly figured out from public sources and actual ESPI files.\n\nForked from the original repository [greenbutton-objects](https://github.com/asciipip/greenbutton-python)\nand packaged to be published on PyPI.\n\nUsed by the Code for Boston [Home Energy Analysis Tool](https://github.com/codeforboston/home-energy-analysis-tool).\n\n\n## Development\nSimple steps for development setup:\n\n1. Clone the git repository.\n3. Navigate to any directory and create a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments) and activate it\n4. The following commands can be run from inside the top-level greenbutton_objects folder while the virtual environment is active\n2. `pip install -e .` builds the [python egg](https://stackoverflow.com/questions/2051192/what-is-a-python-egg) for greenbutton_objects and then installs greenbutton_objects\n3. `pip install -r requirements-dev.txt` which installs the libraries required to develop greenbutton_objects\n\nThen, you should be able to run `pytest`, also from any directory, and see the test run successfully.\n",
"bugtrack_url": null,
"license": "Copyright 2016 Phil! Gold <phil_g@pobox.com> See the NOTICE file for information about related copyrighted works. Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ",
"summary": "Parse Green Button XML files into Python objects.",
"version": "2024.7.11",
"project_urls": {
"Homepage": "https://github.com/codeforboston/greenbutton_objects"
},
"split_keywords": [
"feed",
" reader",
" tutorial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6260c91f79e68f542f39cd6e1b64a5ffef9f5b4e3e340d59276c1ac221def6c9",
"md5": "99a0a0e118a18fdfc550b6d2874c94a2",
"sha256": "7efe28572b3461899bd15880622cbb0b8b7e12fd71c22e7db2c620e37893e79f"
},
"downloads": -1,
"filename": "greenbutton_objects-2024.7.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99a0a0e118a18fdfc550b6d2874c94a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7",
"size": 10284,
"upload_time": "2024-07-11T20:51:11",
"upload_time_iso_8601": "2024-07-11T20:51:11.692590Z",
"url": "https://files.pythonhosted.org/packages/62/60/c91f79e68f542f39cd6e1b64a5ffef9f5b4e3e340d59276c1ac221def6c9/greenbutton_objects-2024.7.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98996c4603cd1482fbe07f9856bd798b5d2fbd838fa4d322c1f5167c47579c72",
"md5": "a5e597799f9579d52ded86244185f801",
"sha256": "2c57221d8f9dd0c85059d7e787f841b8166deb214dbaec423025185acc68f5c2"
},
"downloads": -1,
"filename": "greenbutton_objects-2024.7.11.tar.gz",
"has_sig": false,
"md5_digest": "a5e597799f9579d52ded86244185f801",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 9689,
"upload_time": "2024-07-11T20:51:17",
"upload_time_iso_8601": "2024-07-11T20:51:17.936826Z",
"url": "https://files.pythonhosted.org/packages/98/99/6c4603cd1482fbe07f9856bd798b5d2fbd838fa4d322c1f5167c47579c72/greenbutton_objects-2024.7.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-11 20:51:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "codeforboston",
"github_project": "greenbutton_objects",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "greenbutton-objects"
}
