Skip to main content

An unofficial Python library to interface with your USMS account and smart meters.

Project description

USMS

An unofficial Python library to interface with your USMS account and smart meters.

Getting Started

Prerequisites

  • Python >= 3.8
  • pip

Installation

pip install usms

Quickstart

python -m usms --help
usage: __main__.py [-h] [-l LOG] -u USERNAME -p PASSWORD [-m METER] [--unit] [--consumption] [--credit]

options:
  -h, --help            show this help message and exit
  -l LOG, --log LOG
  -u USERNAME, --username USERNAME
  -p PASSWORD, --password PASSWORD
  -m METER, --meter METER
  --unit
  --consumption
  --credit

[!NOTE] The username parameter is the login ID that you use to log-in on the USMS website/app, i.e. your IC Number.

Usage

Providing only the login information will list all meters under the account.

python -m usms -u <ic_number> -p <password>

To-Do

  • Publish package to PyPI
  • Improve README
  • Support for water meter
  • Support for commercial/corporate accounts

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

  • requests
  • BeautifulSoup
  • USMS

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

usms-0.2.0.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

usms-0.2.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file usms-0.2.0.tar.gz.

File metadata

  • Download URL: usms-0.2.0.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for usms-0.2.0.tar.gz
Algorithm Hash digest
SHA256 304a1c5d6edf89d8d998aed18844db08fd49a8e689664b140ff6dfcaf3c3bf88
MD5 3ff5c556fc79a5ffbfa13bc7ee02bcda
BLAKE2b-256 d235ac7ccb8132311c01b112e4e26a22f64ea4528502b49c0d75022797c0ecb1

See more details on using hashes here.

File details

Details for the file usms-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: usms-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for usms-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 15b5fc1ef65a03d36cd869ee96fdad522bf6cc97910c3e6c8d369eb82855342e
MD5 e85cdd673381ee8c6c10db549fc4f19e
BLAKE2b-256 66a26b4898b7871c261387e0882d3bf090136ac234adbfc4945b52d2f2f56326

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page