pygoodwe


Namepygoodwe JSON
Version 0.1.7 PyPI version JSON
download
home_page
SummaryA command line tool and python library to query the GOODWE SEMS Portal APIs.
upload_time2024-01-15 00:29:41
maintainer
docs_urlNone
authorJames Hodgkinson
requires_python>=3.8,<4.0
licenseMIT
keywords goodwe solar api pygoodwe
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# pygoodwe

A command line tool and python library to query the GOODWE SEMS Portal APIs.

## API Docs

Auto-generated documentation is here: <https://yaleman.github.io/pygoodwe/>

## Installation

You need to have Python 3 and pip installed. Then:

    python -m pip install pygoodwe

Determine the Station ID from the GOODWE site as follows. Open the [Sems Portal](https://www.semsportal.com). The Plant Status will reveal the Station ID in the URL. Example:

    https://www.semsportal.com/powerstation/powerstatussnmin/11112222-aaaa-bbbb-cccc-ddddeeeeeffff

Then the Station ID is `11112222-aaaa-bbbb-cccc-ddddeeeeeffff`.

To use example.py or the other examples, copy config.py.example to config.py and add your details.

## Contributions

Please feel free to lodge an [issue or pull request on GitHub](https://github.com/yaleman/pygoodwe/issues).

## Thanks

* Originally based off the work of [Mark Ruys and his gw2pvo software](https://github.com/markruys/gw2pvo) - I needed something more flexible, so I made this.

## Disclaimer

GOODWE access is based on the undocumented API used by mobile apps. This could break at any time.

## Example Code

Please check out test.py in the base of the repository for some simple example code.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pygoodwe",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "goodwe,solar,api,pygoodwe",
    "author": "James Hodgkinson",
    "author_email": "james@terminaloutcomes.com",
    "download_url": "https://files.pythonhosted.org/packages/3e/53/142cc9b6ee3519154a682638cdf17e799a034ffb013c188dca976783949d/pygoodwe-0.1.7.tar.gz",
    "platform": null,
    "description": "\n# pygoodwe\n\nA command line tool and python library to query the GOODWE SEMS Portal APIs.\n\n## API Docs\n\nAuto-generated documentation is here: <https://yaleman.github.io/pygoodwe/>\n\n## Installation\n\nYou need to have Python 3 and pip installed. Then:\n\n    python -m pip install pygoodwe\n\nDetermine the Station ID from the GOODWE site as follows. Open the [Sems Portal](https://www.semsportal.com). The Plant Status will reveal the Station ID in the URL. Example:\n\n    https://www.semsportal.com/powerstation/powerstatussnmin/11112222-aaaa-bbbb-cccc-ddddeeeeeffff\n\nThen the Station ID is `11112222-aaaa-bbbb-cccc-ddddeeeeeffff`.\n\nTo use example.py or the other examples, copy config.py.example to config.py and add your details.\n\n## Contributions\n\nPlease feel free to lodge an [issue or pull request on GitHub](https://github.com/yaleman/pygoodwe/issues).\n\n## Thanks\n\n* Originally based off the work of [Mark Ruys and his gw2pvo software](https://github.com/markruys/gw2pvo) - I needed something more flexible, so I made this.\n\n## Disclaimer\n\nGOODWE access is based on the undocumented API used by mobile apps. This could break at any time.\n\n## Example Code\n\nPlease check out test.py in the base of the repository for some simple example code.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A command line tool and python library to query the GOODWE SEMS Portal APIs.",
    "version": "0.1.7",
    "project_urls": null,
    "split_keywords": [
        "goodwe",
        "solar",
        "api",
        "pygoodwe"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "08f59cc770d18a24c9fd3796b51319eeebd7fea4af1d6ba7821c5dcb5246a3a4",
                "md5": "14a80eeaeda9da4ef0f6187d4a141811",
                "sha256": "b284376b1e54bcaf6affd80942cd0f91f7599f040e59f8c75fa194de2a9f6c8c"
            },
            "downloads": -1,
            "filename": "pygoodwe-0.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "14a80eeaeda9da4ef0f6187d4a141811",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 7860,
            "upload_time": "2024-01-15T00:29:40",
            "upload_time_iso_8601": "2024-01-15T00:29:40.109798Z",
            "url": "https://files.pythonhosted.org/packages/08/f5/9cc770d18a24c9fd3796b51319eeebd7fea4af1d6ba7821c5dcb5246a3a4/pygoodwe-0.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3e53142cc9b6ee3519154a682638cdf17e799a034ffb013c188dca976783949d",
                "md5": "2468c5edf67953d7d4906bf8428fb5c1",
                "sha256": "6168d980981b82d948bcc39c2f7919a3647b7e6288edc6a783d167bb02780d12"
            },
            "downloads": -1,
            "filename": "pygoodwe-0.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "2468c5edf67953d7d4906bf8428fb5c1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 7529,
            "upload_time": "2024-01-15T00:29:41",
            "upload_time_iso_8601": "2024-01-15T00:29:41.930455Z",
            "url": "https://files.pythonhosted.org/packages/3e/53/142cc9b6ee3519154a682638cdf17e799a034ffb013c188dca976783949d/pygoodwe-0.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-15 00:29:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pygoodwe"
}
        
Elapsed time: 1.74518s