An unofficial Xcel Energy® API
Project description
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.get_account_overview() # Retrieves all billing information for the account client.get_bills() # Retrives detailed information for a particular premise: client.get_usages('PREMISE_ID')
Contributing
- Check for open features/bugs or initiate a discussion on one.
- Fork the repository.
- Install the dev environment:
make init
. - Enter the virtual environment:
pipenv shell
- Code your new feature or bug fix.
- Write a test that covers your new functionality.
- Run tests:
make test
- Build new docs:
make docs
- Add yourself to AUTHORS.rst.
- Submit a pull request!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size pyxcel-1.2.1-py2-none-any.whl (15.5 kB) | File type Wheel | Python version py2 | Upload date | Hashes View |
Filename, size pyxcel-1.2.1.tar.gz (12.3 kB) | File type Source | Python version None | Upload date | Hashes View |