pyxcel: A Simple Python API for Xcel Energy® Data

pyxcel is a simple Python library for energy data from Xcel Energy®.

This library works by repeating the same HTTP requests performed by users who view the Xcel Energy® website. Because there is no official "API," this library may stop working at any time.

Installation

$ pip install pyxcel

Usage

import pyxcel

client = pyxcel.Client('username', 'password12345')

# Retrieves the account overview (including energy usage, grades, etc.):
client.overview.get()

# Retrieves all billing information for the account
client.billing.get()

# Retrives detailed information for a particular premise:
client.usages.get('PREMISE_ID')

Contributing

1. Check for open features/bugs or initiate a discussion on one.
2. Fork the repository.
3. Install the dev environment: make init.
4. Enter the virtual environment: pipenv shell
5. Code your new feature or bug fix.
6. Write a test that covers your new functionality.
7. Run tests: make test
8. Build new docs: make docs
9. Add yourself to AUTHORS.rst.
10. Submit a pull request!