Skip to content

Python utilities for retrieving data from the AMI utility portal used by City of Newberry, Florida

License

Notifications You must be signed in to change notification settings

cablesquirrel/Newberry-Florida-AMI-Portal-Utils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🐍 Newberry Florida AMI Portal Utils

Collection of Python scripts for retrieving utility data from Newberry, Florida city utilities.

image

📝 Description

Utilities contained within this repository were created to allow residents of Newberry, FL that have been converted to smart meters (electric, water, or gas) to retrieve their utility data.

The city's 'AMI' (Advanced Metering Infrastructure) system uses a 3rd party service, Sensus-Analytics on the backend to store and display the data collected.

No method was provided for residents to access their raw data easily, thus the need for these tools.

✅ Pre-requisites

🌎 Environment Variables

This project utilizes a .env file to store user credentials for authenticating with the utility provider. You must create this file in the root of the project.

.env.example is provided as a template for the required variables. Duplicate this file as .env and fill in the required values.

# Username and password used to log into utility website
UTILITY_USERNAME="12345"
UTILITY_PASSWORD="MyPassword"

# Account Number
# Usually the same as your username
# If you are unsure, your account number can be found on your latest bill
ACCOUNT_NUMBER="12345"

📋 Virtual Environment and Dependencies

This project uses Python Poetry to manage dependencies. To install the required dependencies, run the following command:

# Install python version 3.12.5
pyenv install 3.12.5

# Activate python 3.12.5 in the current shell
pyenv shell 3.12.5

# Create a virtual environment and install dependencies
poetry install

# Activate the virtual environment
poetry shell

After installation, the next time the environment is needed, simply activate the shell.

poetry shell

🏃‍➡️ Running Scripts

Below is a list of the available scripts.

Visit each script's page for details on usage.

About

Python utilities for retrieving data from the AMI utility portal used by City of Newberry, Florida

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages