Skip to main content

An unofficial Xcel Energy® API

Project description

pyxcel: A Simple Python API for Xcel Energy® Data

https://travis-ci.org/bachya/pyxcel.svg?branch=master https://img.shields.io/pypi/v/pyxcel.svg https://img.shields.io/pypi/pyversions/pyxcel.svg https://img.shields.io/pypi/l/pyxcel.svg https://codecov.io/gh/bachya/pyxcel/branch/master/graph/badge.svg https://api.codeclimate.com/v1/badges/71eb642c735e33adcdfc/maintainability https://img.shields.io/badge/SayThanks-!-1EAEDB.svg

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

  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!

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 & hash SHA256 hash help File type Python version Upload date
pyxcel-1.2.1-py2-none-any.whl (15.5 kB) Copy SHA256 hash SHA256 Wheel py2
pyxcel-1.2.1.tar.gz (12.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page