# eGauge open source Python code
This repository is a collection of Python packages that have been
released by eGauge Systems LLC as open source (MIT license). These
are released in the hope that they may be useful for other developers.
Please see LICENSE for details. eGauge Systems LLC reserves the
rights to add, modify, or remove code from this repository or the
entire repository without notice.
## egauge.pyside.terminal Support
To use module `egauge.pyside.terminal`, be sure to install the package
with the `pyside` extra dependencies:
```sh
pip install egauge-python[pyside]
```
## Example Programs
Example programs can be found in the `egauge.examples` module. If you
want to run these programs, ensure that all dependencies are installed
by running the command:
```sh
pip install egauge-python[examples]
```
The following examples are available:
* `test_capture`: Illustrates the use of the
`egauge.webapi.device.Capture` class to capture waveform data.
* `test_ctid_decoder`: Illustrates how the `egauge.ctid.Decoder` can be
used to decode CTid information from a waveform.
* `test_ctid`: Illustrates how the `egauge.webapi.device.CTidInfo`
class can be used to control a meter to scan CTid information from
a sensor, make the sensor blink the indicator LED, and so on.
* `test_local`: Illustrates how the `egauge.webapi.device.Local`
class can be used to fetch and display the locally acquired
measurements of a meter.
* `test_register`: Illustrates how the `egauge.webapi.device.Register`
class can be used to fetch and display the register data of a
meter.
Before running these programs, set the following environment variables
for your preferred test device:
* `EGDEV`: URL of the test device (e.g., "http://eGaugeXXXXX.local" or
"http://eGaugeXXXX.d.egauge.net")
* `EGUSR`: Username to authenticate with (e.g., "owner")
* `EGPWD`: Password to authenticate with (e.g., "super-secret-pw")
For example, the test program that illustrates the use of the register
data interface can be run with the command:
```
python -m egauge.examples.test_register
```
## Overview of available modules
### egauge.webapi
The classes in this module provide access to eGauge web services. The
APIs may be available on eGauge devices and/or as cloud-based web
services.
### egauge.webapi.device
The classes in this module provide access to APIs implemented on
eGauge devices.
### egauge.webapi.cloud
The classes in this module provide access to APIs implemented by
eGauge cloud services.
### egauge.ctid
The classes in this module support manufacturing CTid® sensors. CTid®
is patented technology and shall be used in accordance with the
licensing agreements governing its use.
### egauge.pyside
The classes in this module support QT6-based graphical
user-interfaces.
## Source Code Conventions
Source code should be formatted with `ruff format` using a maximum
line-length of 79 characters. The formatter can be installed with
`pip install ruff`.
Source code should be validated with `ruff check` and `pyright`. The
latter can be installed with `pip install pyright`.
To do these things automatically before committing a change, install
the pre-commit hooks with:
```sh
pip install pre-commit
pre-commit install
```
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/egauge/python/",
"name": "egauge-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "David Mosberger-Tang",
"author_email": "davidm@egauge.net",
"download_url": null,
"platform": null,
"description": "# eGauge open source Python code\n\nThis repository is a collection of Python packages that have been\nreleased by eGauge Systems LLC as open source (MIT license). These\nare released in the hope that they may be useful for other developers.\nPlease see LICENSE for details. eGauge Systems LLC reserves the\nrights to add, modify, or remove code from this repository or the\nentire repository without notice.\n\n## egauge.pyside.terminal Support\n\nTo use module `egauge.pyside.terminal`, be sure to install the package\nwith the `pyside` extra dependencies:\n\n```sh\npip install egauge-python[pyside]\n```\n\n## Example Programs\n\nExample programs can be found in the `egauge.examples` module. If you\nwant to run these programs, ensure that all dependencies are installed\nby running the command:\n\n```sh\npip install egauge-python[examples]\n```\n\nThe following examples are available:\n\n * `test_capture`: Illustrates the use of the\n `egauge.webapi.device.Capture` class to capture waveform data.\n\n * `test_ctid_decoder`: Illustrates how the `egauge.ctid.Decoder` can be\n used to decode CTid information from a waveform.\n\n * `test_ctid`: Illustrates how the `egauge.webapi.device.CTidInfo`\n class can be used to control a meter to scan CTid information from\n a sensor, make the sensor blink the indicator LED, and so on.\n\n * `test_local`: Illustrates how the `egauge.webapi.device.Local`\n class can be used to fetch and display the locally acquired\n measurements of a meter.\n\n * `test_register`: Illustrates how the `egauge.webapi.device.Register`\n class can be used to fetch and display the register data of a\n meter.\n\nBefore running these programs, set the following environment variables\nfor your preferred test device:\n\n * `EGDEV`: URL of the test device (e.g., \"http://eGaugeXXXXX.local\" or\n \"http://eGaugeXXXX.d.egauge.net\")\n * `EGUSR`: Username to authenticate with (e.g., \"owner\")\n * `EGPWD`: Password to authenticate with (e.g., \"super-secret-pw\")\n\nFor example, the test program that illustrates the use of the register\ndata interface can be run with the command:\n\n```\n python -m egauge.examples.test_register\n```\n\n## Overview of available modules\n\n### egauge.webapi\n\nThe classes in this module provide access to eGauge web services. The\nAPIs may be available on eGauge devices and/or as cloud-based web\nservices.\n\n### egauge.webapi.device\n\nThe classes in this module provide access to APIs implemented on\neGauge devices.\n\n### egauge.webapi.cloud\n\nThe classes in this module provide access to APIs implemented by\neGauge cloud services.\n\n### egauge.ctid\n\nThe classes in this module support manufacturing CTid\u00ae sensors. CTid\u00ae\nis patented technology and shall be used in accordance with the\nlicensing agreements governing its use.\n\n### egauge.pyside\n\nThe classes in this module support QT6-based graphical\nuser-interfaces.\n\n## Source Code Conventions\n\nSource code should be formatted with `ruff format` using a maximum\nline-length of 79 characters. The formatter can be installed with\n`pip install ruff`.\n\nSource code should be validated with `ruff check` and `pyright`. The\nlatter can be installed with `pip install pyright`.\n\nTo do these things automatically before committing a change, install\nthe pre-commit hooks with:\n\n```sh\n pip install pre-commit\n pre-commit install\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Support code for communicating with eGauge hardware.",
"version": "0.9.8",
"project_urls": {
"Homepage": "https://bitbucket.org/egauge/python/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b1f2f3eee20e05513d881c42019964276a660019d8c2deed01f93e6efa4b9ae9",
"md5": "fe25600decd1a7f6f3e70ae5c73a26d4",
"sha256": "33d550f04376982fe9310bed8a397f4e38ef883ebc2dceee6010001567e0fdc3"
},
"downloads": -1,
"filename": "egauge_python-0.9.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe25600decd1a7f6f3e70ae5c73a26d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 163061,
"upload_time": "2025-07-18T15:58:46",
"upload_time_iso_8601": "2025-07-18T15:58:46.503099Z",
"url": "https://files.pythonhosted.org/packages/b1/f2/f3eee20e05513d881c42019964276a660019d8c2deed01f93e6efa4b9ae9/egauge_python-0.9.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 15:58:46",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "egauge",
"bitbucket_project": "python",
"lcname": "egauge-python"
}
JSON