A utility that reads electric utility meter data from Evergy.com
Project description
⚡Evergy Client
A simple utility that you can use to login to your Evergy account and retrieve you meter readings.
Note: This is an unofficial utility that uses Evergy's non-public API.
Previously known as "KCPL"
Install
pip install evergy
Usage
# Import the package
from evergy import Evergy
# Login
evergy = Evergy("username", "password")
evergy.login()
# Get a list of daily readings
# Note, there is more data available such as 'cost' and 'avgTemp'
data = evergy.get_usage()
logging.info("Last usage reading: " + str(data[-1]))
logging.info("Last usage reading: " + str(data[-1]["usage"]))
# End your session by logging out
evergy.logout()
Development
Setup
python -m pip install --upgrade virtualenv
virtualenv venv
.\venv\Scripts\activate.ps1
Code Formatting
Install the dev dependencies and run isort
and flake8
to properly format the code.
pip install -r requirements_dev.txt
isort evergy/
flake8 evergy/
Build Docs
Windows PowerShell:
pip install -r docs/requirements_docs.txt
docs\make.bat clean; docs\make.bat html
Release New Version
- Bump
__version__
inevergy/__init__.py
git commit -m "Bump version"
git tag -a v1.0.1 -m "v1.0.1"
git push --tags
Build Wheel
The
--no-isolation
flag tells it to use the existing virtual env
python -m build --no-isolation --wheel
Upload to PyPi
Test
twine upload --verbose -u "username" -p "password" --repository testpypi dist/*
Prod
twine upload --verbose -u "username" -p "password" --repository pypi dist/*
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
evergy-1.1.0-py3-none-any.whl
(4.8 kB
view hashes)