GreenWorks


NameGreenWorks JSON
Version 0.1.0.0 PyPI version JSON
download
home_pageNone
SummaryAn API wrapper for the Greenworks robotic lawn mower
upload_time2025-08-12 05:52:57
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # GreenWorks-Core

GreenWorks-Core is a Python package that provides an API wrapper for the Greenworks robotic lawn mower, enabling you to authenticate, list devices, and retrieve mower status and properties.

## Install

Install from PyPI (name subject to change if unpublished):

```
pip install GreenWorks
```

## Quick start

```python
from src.GreenWorksAPI.GreenWorksAPI import GreenWorksAPI

api = GreenWorksAPI("you@example.com", "your-password", "Europe/Copenhagen")
devices = api.get_devices()
for d in devices:
		print(d.name, d.is_online, d.operating_status.mower_main_state)
```

## Logging

This library uses the standard Python `logging` module with a module-level logger. No handlers are configured by default (a NullHandler is attached), so logs are propagated to the host application.

### Home Assistant

Home Assistant captures Python logs. To enable debug logs for this library, add to your `configuration.yaml`:

```
logger:
	default: warning
	logs:
		src.GreenWorksAPI: debug
```

You can also target a single module:

```
logger:
	logs:
		src.GreenWorksAPI.GreenWorksAPI: debug
```

### Standalone scripts

```python
import logging
logging.basicConfig(level=logging.INFO)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "GreenWorks",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Christian Boes <boes9@icloud.com>",
    "download_url": "https://files.pythonhosted.org/packages/4b/d5/a49ccee069e0188ed4b08914dda55bd45d6f3442ee864f7b75ae5df2e0bd/greenworks-0.1.0.0.tar.gz",
    "platform": null,
    "description": "# GreenWorks-Core\n\nGreenWorks-Core is a Python package that provides an API wrapper for the Greenworks robotic lawn mower, enabling you to authenticate, list devices, and retrieve mower status and properties.\n\n## Install\n\nInstall from PyPI (name subject to change if unpublished):\n\n```\npip install GreenWorks\n```\n\n## Quick start\n\n```python\nfrom src.GreenWorksAPI.GreenWorksAPI import GreenWorksAPI\n\napi = GreenWorksAPI(\"you@example.com\", \"your-password\", \"Europe/Copenhagen\")\ndevices = api.get_devices()\nfor d in devices:\n\t\tprint(d.name, d.is_online, d.operating_status.mower_main_state)\n```\n\n## Logging\n\nThis library uses the standard Python `logging` module with a module-level logger. No handlers are configured by default (a NullHandler is attached), so logs are propagated to the host application.\n\n### Home Assistant\n\nHome Assistant captures Python logs. To enable debug logs for this library, add to your `configuration.yaml`:\n\n```\nlogger:\n\tdefault: warning\n\tlogs:\n\t\tsrc.GreenWorksAPI: debug\n```\n\nYou can also target a single module:\n\n```\nlogger:\n\tlogs:\n\t\tsrc.GreenWorksAPI.GreenWorksAPI: debug\n```\n\n### Standalone scripts\n\n```python\nimport logging\nlogging.basicConfig(level=logging.INFO)\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "An API wrapper for the Greenworks robotic lawn mower",
    "version": "0.1.0.0",
    "project_urls": {
        "Documentation": "https://github.com/Boes24/GreenWorks-Core",
        "Issues": "https://github.com/Boes24/GreenWorks-Core/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8b977b786e19bbbc66161609c3d45ef00d1b19594e9d155f89235905c068c6f2",
                "md5": "7b5fdd3947296f0ffc913b3f46d21178",
                "sha256": "a1a139ff89a08bfbcf785e1453afbd1434867c151e50f6690b6038af94827023"
            },
            "downloads": -1,
            "filename": "greenworks-0.1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7b5fdd3947296f0ffc913b3f46d21178",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 7347,
            "upload_time": "2025-08-12T05:52:56",
            "upload_time_iso_8601": "2025-08-12T05:52:56.542137Z",
            "url": "https://files.pythonhosted.org/packages/8b/97/7b786e19bbbc66161609c3d45ef00d1b19594e9d155f89235905c068c6f2/greenworks-0.1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4bd5a49ccee069e0188ed4b08914dda55bd45d6f3442ee864f7b75ae5df2e0bd",
                "md5": "bb4cca8fec6f726b1c77c3b7cec72101",
                "sha256": "a283ee9ab1a0dfed7f5595ba4b4aa395b523b86ada4960f16d726e572fe45a19"
            },
            "downloads": -1,
            "filename": "greenworks-0.1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bb4cca8fec6f726b1c77c3b7cec72101",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 6317,
            "upload_time": "2025-08-12T05:52:57",
            "upload_time_iso_8601": "2025-08-12T05:52:57.628699Z",
            "url": "https://files.pythonhosted.org/packages/4b/d5/a49ccee069e0188ed4b08914dda55bd45d6f3442ee864f7b75ae5df2e0bd/greenworks-0.1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-12 05:52:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Boes24",
    "github_project": "GreenWorks-Core",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "greenworks"
}
        
Elapsed time: 1.75989s