pynrelutility is a Python package to read NREL's API for utility rates
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
requirements
.gitignore
.travis.yml
LICENSE
README.md
__init__.py
__version__.py
nrel_utility.py
nrel_utility_errors.py
setup.py
test.py

README.md

================== NREL Utility Wrapper 0.1

Hannes Hapke 10/09/2015

README

This is a Python wrapper for NREL's utility API.

It allows you to directly convert an address into utility information (utility name, residential, commercial and industrial electricity costs).

License

MIT

Dependencies

requests library is needed and will be installed by setuptools. It is developed on Python 2.7 and tested with Python 3.4.

Installation

You can install this package using pip:

pip install pynrelutility

or download the source from https://github.com/hanneshapke/pynrelutility and install

python setup.py install

Also obtain a free API key from NREL.

Usage of the NREL Census Utility API

from pynrelutility import NRELUtilityWrapper, NRELUtilityResults
...
address = 'YOUR ADDRESS'
...
nrel_data = NRELUtilityWrapper(YOUR_NREL_API_KEY)
nrel_response = nrel_data.get_nrel_utility_data(address)
result = NRELUtilityResults(nrel_response)
...
result.utility_name # displays the names of all utilities at the location

The following attributes are currently supported:

- utility_name
- utility_name_list
- commercial
- residential
- industrial

Contributors

Contact Information

For comments, issues, requests, please contact via Github at the above website

Changelog

Version 0.1 > Project created, test.py and setup.py created