# 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 also reserved the
rights to add, modify, or remove code from this repository or the
entire repository without notice.
## Example Programs
Example programs can be found in the `examples` subdirectory. If you
want to run these programs, ensure that all dependencies are installed
by running the command:
```sh
pip install egauge-python[examples]
```
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")
## 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.pyside2
The classes in this module support QT5-based graphical
user-interfaces.
## Source Code Conventions
Source code should be formatted with ``black`` using a maximum line-length
of 79 characters. Black can be installed with ``pip install black``.
If the resulting output is inadequate for some reason, such as manually
formatted data tables, you can make judicious use of ``# fmt: off`` and
``# fmt: on`` to disable formatting for the relevant lines.
Source code should be syntax checked with pylint. Pylint can be
installed with ``pip install pylint``. You can make judicious use
of ``# pylint: disable=``\ *warning-name* to temporarily disable
warnings that can safely be ignored.
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/egauge/python/",
"name": "egauge-python",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "David Mosberger-Tang",
"author_email": "davidm@egauge.net",
"download_url": "https://files.pythonhosted.org/packages/6d/0c/96660cd02047b0ff805b729ddeaaa1a15cc3dfc7f2d0cdc0c10d01eca870/egauge-python-0.7.5.tar.gz",
"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 also reserved the\nrights to add, modify, or remove code from this repository or the\nentire repository without notice.\n\n## Example Programs\n\nExample programs can be found in the `examples` subdirectory. 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\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\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.pyside2\n\nThe classes in this module support QT5-based graphical\nuser-interfaces.\n\n## Source Code Conventions\n\nSource code should be formatted with ``black`` using a maximum line-length\nof 79 characters. Black can be installed with ``pip install black``.\nIf the resulting output is inadequate for some reason, such as manually\nformatted data tables, you can make judicious use of ``# fmt: off`` and\n``# fmt: on`` to disable formatting for the relevant lines.\n\nSource code should be syntax checked with pylint. Pylint can be\ninstalled with ``pip install pylint``. You can make judicious use\nof ``# pylint: disable=``\\ *warning-name* to temporarily disable\nwarnings that can safely be ignored.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": ".",
"version": "0.7.5",
"project_urls": {
"Homepage": "https://bitbucket.org/egauge/python/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d0c96660cd02047b0ff805b729ddeaaa1a15cc3dfc7f2d0cdc0c10d01eca870",
"md5": "13e4c447b01b2d136f7bcbaa7cf6dda0",
"sha256": "f1760d0f9d97ca44e245cdeb720aa221bca5f689bfe1a2a2c39e49400fc5b065"
},
"downloads": -1,
"filename": "egauge-python-0.7.5.tar.gz",
"has_sig": false,
"md5_digest": "13e4c447b01b2d136f7bcbaa7cf6dda0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 58991,
"upload_time": "2023-08-22T15:22:22",
"upload_time_iso_8601": "2023-08-22T15:22:22.066655Z",
"url": "https://files.pythonhosted.org/packages/6d/0c/96660cd02047b0ff805b729ddeaaa1a15cc3dfc7f2d0cdc0c10d01eca870/egauge-python-0.7.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-22 15:22:22",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "egauge",
"bitbucket_project": "python",
"lcname": "egauge-python"
}
JSON