greenbutton-objects

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 and packaged to be published on PyPI.

Used by the Code for Boston Home Energy Analysis Tool.

Development

Simple steps for development setup:

1. Clone the git repository.
2. Navigate to any directory and create a virtual environment and activate it
3. The following commands can be run from inside the top-level greenbutton_objects folder while the virtual environment is active
4. pip install -e . builds the python egg for greenbutton_objects and then installs greenbutton_objects
5. 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.