regenmaschine


Nameregenmaschine JSON
Version 2024.3.0 PyPI version JSON
download
home_pagehttps://github.com/bachya/regenmaschine
SummaryA simple API for RainMachine sprinkler controllers
upload_time2024-03-11 15:30:57
maintainer
docs_urlNone
authorAaron Bach
requires_python>=3.10,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 💧 Regenmaschine: A Simple Python Library for RainMachine™

[![CI][ci-badge]][ci]
[![PyPI][pypi-badge]][pypi]
[![Version][version-badge]][version]
[![License][license-badge]][license]
[![Code Coverage][codecov-badge]][codecov]
[![Maintainability][maintainability-badge]][maintainability]

<a href="https://www.buymeacoffee.com/bachya1208P" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>

`regenmaschine` (German for "rain machine") is a simple, clean, well-tested
Python library for interacting with
[RainMachineâ„¢ smart sprinkler controllers][regenmaschine]. It gives developers an easy
API to manage their controllers over their local LAN or remotely via the RainMachineâ„¢
cloud.

- [Remote Access Announcement](#remote-access-announcement-2022-06-26)
- [Python Versions](#python-versions)
- [Installation](#installation)
- [Usage](#usage)
- [Loading Controllers Multiple Times](#loading-controllers-multiple-times)
- [Contributing](#contributing)

# Remote Access Announcement (2022-06-26)

On June 2, 2022, RainMachine announced a [Premium Services][rainmachine-premium]
addition; under this new model, remote access is _only_ available to subscribers of
these Premium Services.

I do not currently intend to subscribe to Premium Services; as such, the remote access
abilities of `regenmaschine` will remain as-is from here on out unless spurred on by
others. They may stop working at any time. PRs from subscribing users are always
welcome.

# Python Versions

`regenmaschine` is currently supported on:

- Python 3.10
- Python 3.11
- Python 3.12

# Installation

```bash
pip install regenmaschine
```

# Usage

Creating a `regenmaschine` `Client` might be the easiest thing you do all day:

```python
import asyncio

from aiohttp import ClientSession

from regenmaschine import Client


async def main() -> None:
    """Run!"""
    client = Client()

    # ...


asyncio.run(main())
```

By default, the library creates a new connection to the sprinkler controller with each
coroutine. If you are calling a large number of coroutines (or merely want to squeeze
out every second of runtime savings possible), an [`aiohttp`][aiohttp] `ClientSession` can
be used for connection pooling:

See the module docstrings throughout the library for full info on all parameters, return
types, etc.

```python
import asyncio

from aiohttp import ClientSession

from regenmaschine import Client


async def main() -> None:
    """Run!"""
    async with ClientSession() as session:
        client = Client(session=session)


asyncio.run(main())
```

## Loading Local (Accessible Over the LAN) Controllers

Once you have a client, you can load a local controller (i.e., one that is
accessible over the LAN) very easily:

```python
import asyncio

from aiohttp import ClientSession

from regenmaschine import Client


async def main() -> None:
    """Run!"""
    async with ClientSession() as session:
        client = Client(session=session)

        await client.load_local("192.168.1.101", "my_password", port=8080, use_ssl=True)

        controllers = client.controllers
        # >>> {'ab:cd:ef:12:34:56': <LocalController>}


asyncio.run(main())
```

## Loading Remote (Accessible Over the RainMachine Cloud) Controllers

If you have 1, 2 or 100 other local controllers, you can load them in the same
way – `client.controllers` will keep your controllers all organized.

What if you have controllers around the world and can't access them all over
the same local network? No problem! `regenmaschine` allows you to load remote
controllers very easily, as well:

```python
import asyncio

from aiohttp import ClientSession

from regenmaschine import Client


async def main() -> None:
    """Run!"""
    async with ClientSession() as session:
        client = Client(session=session)

        await client.load_remote("rainmachine_email@host.com", "my_password")

        controllers = client.controllers
        # >>> {'xx:xx:xx:xx:xx:xx': <RemoteController>, ...}


asyncio.run(main())
```

Bonus tip: `client.load_remote` will load _all_ controllers owned by that email
address.

## Using the Controller

Regardless of the type of controller you have loaded (local or remote), the
same properties and methods are available to each:

```python
import asyncio
import datetime

from aiohttp import ClientSession

from regenmaschine import Client


async def main() -> None:
    """Run!"""
    async with ClientSession() as session:
        client = Client(session=session)

        # Load a local controller:
        await client.load_local("192.168.1.101", "my_password", port=8080, use_ssl=True)

        # Load all remote controllers associated with an account:
        await client.load_remote("rainmachine_email@host.com", "my_password")

        # They all act the same! The only difference is that remote API calls
        # will pass through the RainMachineâ„¢ cloud:
        for mac_address, controller in client.controllers:
            # Print some client properties:
            print(f"Name: {controller.name}")
            print(f"Host: {controller.host}")
            print(f"MAC Address: {controller.mac}")
            print(f"API Version: {controller.api_version}")
            print(f"Software Version: {controller.software_version}")
            print(f"Hardware Version: {controller.hardware_version}")

            # Get all diagnostic information:
            diagnostics = await controller.diagnostics.current()

            # Get all weather parsers:
            parsers = await controller.parsers.current()

            # Get all programs:
            programs = await controller.programs.all()

            # Include inactive programs:
            programs = await controller.programs.all(include_inactive=True)

            # Get a specific program:
            program_1 = await controller.programs.get(1)

            # Enable or disable a specific program:
            await controller.programs.enable(1)
            await controller.programs.disable(1)

            # Get the next run time for all programs:
            runs = await controller.programs.next()

            # Get all running programs:
            programs = await controller.programs.running()

            # Start and stop a program:
            await controller.programs.start(1)
            await controller.programs.stop(1)

            # Get basic details about all zones:
            zones = await controller.zones.all()

            # Get advanced details about all zones:
            zones = await controller.zones.all(details=True)

            # Include inactive zones:
            zones = await controller.zones.all(include_inactive=True)

            # Get basic details about a specific zone:
            zone_1 = await controller.zones.get(1)

            # Get advanced details about a specific zone:
            zone_1 = await controller.zones.get(1, details=True)

            # Enable or disable a specific zone:
            await controller.zones.enable(1)
            await controller.zones.disable(1)

            # Start a zone for 60 seconds:
            await controller.zones.start(1, 60)

            # ...and stop it:
            await controller.zones.stop(1)

            # Get all running zones:
            programs = await controller.zones.running()

            # Get the device name:
            name = await controller.provisioning.device_name

            # Get all provisioning settings:
            settings = await controller.provisioning.settings()

            # Get all networking info related to the device:
            wifi = await controller.provisioning.wifi()

            # Get various types of active watering restrictions:
            current = await controller.restrictions.current()
            universal = await controller.restrictions.universal()
            hourly = await controller.restrictions.hourly()
            raindelay = await controller.restrictions.raindelay()

            # Set universal restrictions – note that the payload is the same structure
            # as returned by controller.restrictions.universal():
            await controller.restrictions.set_universal(
                {
                    "hotDaysExtraWatering": False,
                    "freezeProtectEnabled": True,
                }
            )

            # Get watering stats:
            today = await controller.stats.on_date(datetime.date.today())
            upcoming_days = await controller.stats.upcoming(details=True)

            # Get info on various watering activities not already covered:
            log = await controller.watering.log(datetime.date.today(), 2)
            queue = await controller.watering.queue()
            runs = await controller.watering.runs(datetime.date.today())

            # Pause all watering activities for 30 seconds:
            await controller.watering.pause_all(30)

            # Unpause all watering activities:
            await controller.watering.unpause_all()

            # Stop all watering activities:
            await controller.watering.stop_all()

            # See if a firmware update is available:
            update_data = await controller.machine.get_firmware_update_status()
            # ...and request the update:
            update_data = await controller.machine.update_firmware()

            # Reboot the controller:
            update_data = await controller.machine.reboot()

            # Return the current flow meter data:
            flowmeter = await controller.watering.flowmeter()

            # Add values to flowmeter counters from an external smart water meter
            # not wired directly to the controller.
            # Units can be "clicks", "gal", "m3" and "litre".
            await controller.watering.post_flowmeter({"value": 2000, "units": "clicks"})


asyncio.run(main())
```

Check out `example.py`, the tests, and the source files themselves for method
signatures and more examples. For additional reference, the full RainMachineâ„¢ API
documentation is available [here][rainmachine-api].

# Loading Controllers Multiple Times

It is technically possible to load a controller multiple times. Let's pretend
for a moment that:

- We have a local controller named `Home` (available at `192.168.1.101`).
- We have a remote controller named `Grandma's House`.
- Both controllers live under our email address: `user@host.com`

If we load them thus:

```python
import asyncio

from aiohttp import ClientSession

from regenmaschine import Client


async def main() -> None:
    """Run!"""
    async with ClientSession() as session:
        client = Client(session=session)

        # Load "Home" locally:
        await client.load_local("192.168.1.101", "my_password")

        # Load all of my controllers remotely:
        await client.load_remote("user@host.com", "my_password")


asyncio.run(main())
```

...then we will have the following:

1. `Home` will be a `LocalController` and accessible over the LAN.
2. `Grandma's House` will be a `RemoteController` and accessible only over the
   RainMachineâ„¢ cloud.

Notice that `regenmaschine` is smart enough to not overwrite a controller that
already exists: even though `Home` exists as a remote controller owned by
`user@host.com`, it had already been loaded locally. By default,
`regenmaschine` will only load a controller if it hasn't been loaded before
(locally _or_ remotely). If you want to change this behavior, both `load_local`
and `load_remote` accept an optional `skip_existing` parameter:

```python
import asyncio

from aiohttp import ClientSession

from regenmaschine import Client


async def main() -> None:
    """Run!"""
    async with ClientSession() as session:
        client = Client(session=session)

        # Load all of my controllers remotely:
        await client.load_remote("user@host.com", "my_password")

        # Load "Home" locally, overwriting the existing remote controller:
        await client.load_local("192.168.1.101", "my_password", skip_existing=False)


asyncio.run(main())
```

# Contributing

Thanks to all of [our contributors][contributors] so far!

1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].
2. [Fork the repository][fork].
3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`
4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`
5. Install the dev environment: `script/setup`
6. Code your new feature or bug fix on a new branch.
7. Write tests that cover your new functionality.
8. Run tests and ensure 100% code coverage: `poetry run pytest --cov regenmaschine tests`
9. Update `README.md` with any new documentation.
10. Submit a pull request!

[aiohttp]: https://github.com/aio-libs/aiohttp
[ci-badge]: https://img.shields.io/github/actions/workflow/status/bachya/regenmaschine/test.yml
[ci]: https://github.com/bachya/regenmaschine/actions
[codecov-badge]: https://codecov.io/gh/bachya/regenmaschine/branch/dev/graph/badge.svg
[codecov]: https://codecov.io/gh/bachya/regenmaschine
[contributors]: https://github.com/bachya/regenmaschine/graphs/contributors
[fork]: https://github.com/bachya/regenmaschine/fork
[issues]: https://github.com/bachya/regenmaschine/issues
[license-badge]: https://img.shields.io/pypi/l/regenmaschine.svg
[license]: https://github.com/bachya/regenmaschine/blob/main/LICENSE
[maintainability-badge]: https://api.codeclimate.com/v1/badges/cb14e60d5f5a4c2ccb2c/maintainability
[maintainability]: https://codeclimate.com/github/bachya/regenmaschine/maintainability
[new-issue]: https://github.com/bachya/regenmaschine/issues/new
[pypi-badge]: https://img.shields.io/pypi/v/regenmaschine.svg
[pypi]: https://pypi.python.org/pypi/regenmaschine
[rainmachine-api]: https://rainmachine.docs.apiary.io/
[rainmachine-premium]: https://www.rainmachine.com/premium/
[regenmaschine]: http://www.rainmachine.com/
[version-badge]: https://img.shields.io/pypi/pyversions/regenmaschine.svg
[version]: https://pypi.python.org/pypi/regenmaschine

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bachya/regenmaschine",
    "name": "regenmaschine",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Aaron Bach",
    "author_email": "bachya1208@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/05/e1/e76f285c6cc6b144ef71d52ee081b6c1cbbf7b3af01f55c1e4f85407f37f/regenmaschine-2024.3.0.tar.gz",
    "platform": null,
    "description": "# \ud83d\udca7 Regenmaschine: A Simple Python Library for RainMachine\u2122\n\n[![CI][ci-badge]][ci]\n[![PyPI][pypi-badge]][pypi]\n[![Version][version-badge]][version]\n[![License][license-badge]][license]\n[![Code Coverage][codecov-badge]][codecov]\n[![Maintainability][maintainability-badge]][maintainability]\n\n<a href=\"https://www.buymeacoffee.com/bachya1208P\" target=\"_blank\"><img src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"41\" width=\"174\"></a>\n\n`regenmaschine` (German for \"rain machine\") is a simple, clean, well-tested\nPython library for interacting with\n[RainMachine\u2122 smart sprinkler controllers][regenmaschine]. It gives developers an easy\nAPI to manage their controllers over their local LAN or remotely via the RainMachine\u2122\ncloud.\n\n- [Remote Access Announcement](#remote-access-announcement-2022-06-26)\n- [Python Versions](#python-versions)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Loading Controllers Multiple Times](#loading-controllers-multiple-times)\n- [Contributing](#contributing)\n\n# Remote Access Announcement (2022-06-26)\n\nOn June 2, 2022, RainMachine announced a [Premium Services][rainmachine-premium]\naddition; under this new model, remote access is _only_ available to subscribers of\nthese Premium Services.\n\nI do not currently intend to subscribe to Premium Services; as such, the remote access\nabilities of `regenmaschine` will remain as-is from here on out unless spurred on by\nothers. They may stop working at any time. PRs from subscribing users are always\nwelcome.\n\n# Python Versions\n\n`regenmaschine` is currently supported on:\n\n- Python 3.10\n- Python 3.11\n- Python 3.12\n\n# Installation\n\n```bash\npip install regenmaschine\n```\n\n# Usage\n\nCreating a `regenmaschine` `Client` might be the easiest thing you do all day:\n\n```python\nimport asyncio\n\nfrom aiohttp import ClientSession\n\nfrom regenmaschine import Client\n\n\nasync def main() -> None:\n    \"\"\"Run!\"\"\"\n    client = Client()\n\n    # ...\n\n\nasyncio.run(main())\n```\n\nBy default, the library creates a new connection to the sprinkler controller with each\ncoroutine. If you are calling a large number of coroutines (or merely want to squeeze\nout every second of runtime savings possible), an [`aiohttp`][aiohttp] `ClientSession` can\nbe used for connection pooling:\n\nSee the module docstrings throughout the library for full info on all parameters, return\ntypes, etc.\n\n```python\nimport asyncio\n\nfrom aiohttp import ClientSession\n\nfrom regenmaschine import Client\n\n\nasync def main() -> None:\n    \"\"\"Run!\"\"\"\n    async with ClientSession() as session:\n        client = Client(session=session)\n\n\nasyncio.run(main())\n```\n\n## Loading Local (Accessible Over the LAN) Controllers\n\nOnce you have a client, you can load a local controller (i.e., one that is\naccessible over the LAN) very easily:\n\n```python\nimport asyncio\n\nfrom aiohttp import ClientSession\n\nfrom regenmaschine import Client\n\n\nasync def main() -> None:\n    \"\"\"Run!\"\"\"\n    async with ClientSession() as session:\n        client = Client(session=session)\n\n        await client.load_local(\"192.168.1.101\", \"my_password\", port=8080, use_ssl=True)\n\n        controllers = client.controllers\n        # >>> {'ab:cd:ef:12:34:56': <LocalController>}\n\n\nasyncio.run(main())\n```\n\n## Loading Remote (Accessible Over the RainMachine Cloud) Controllers\n\nIf you have 1, 2 or 100 other local controllers, you can load them in the same\nway \u2013 `client.controllers` will keep your controllers all organized.\n\nWhat if you have controllers around the world and can't access them all over\nthe same local network? No problem! `regenmaschine` allows you to load remote\ncontrollers very easily, as well:\n\n```python\nimport asyncio\n\nfrom aiohttp import ClientSession\n\nfrom regenmaschine import Client\n\n\nasync def main() -> None:\n    \"\"\"Run!\"\"\"\n    async with ClientSession() as session:\n        client = Client(session=session)\n\n        await client.load_remote(\"rainmachine_email@host.com\", \"my_password\")\n\n        controllers = client.controllers\n        # >>> {'xx:xx:xx:xx:xx:xx': <RemoteController>, ...}\n\n\nasyncio.run(main())\n```\n\nBonus tip: `client.load_remote` will load _all_ controllers owned by that email\naddress.\n\n## Using the Controller\n\nRegardless of the type of controller you have loaded (local or remote), the\nsame properties and methods are available to each:\n\n```python\nimport asyncio\nimport datetime\n\nfrom aiohttp import ClientSession\n\nfrom regenmaschine import Client\n\n\nasync def main() -> None:\n    \"\"\"Run!\"\"\"\n    async with ClientSession() as session:\n        client = Client(session=session)\n\n        # Load a local controller:\n        await client.load_local(\"192.168.1.101\", \"my_password\", port=8080, use_ssl=True)\n\n        # Load all remote controllers associated with an account:\n        await client.load_remote(\"rainmachine_email@host.com\", \"my_password\")\n\n        # They all act the same! The only difference is that remote API calls\n        # will pass through the RainMachine\u2122 cloud:\n        for mac_address, controller in client.controllers:\n            # Print some client properties:\n            print(f\"Name: {controller.name}\")\n            print(f\"Host: {controller.host}\")\n            print(f\"MAC Address: {controller.mac}\")\n            print(f\"API Version: {controller.api_version}\")\n            print(f\"Software Version: {controller.software_version}\")\n            print(f\"Hardware Version: {controller.hardware_version}\")\n\n            # Get all diagnostic information:\n            diagnostics = await controller.diagnostics.current()\n\n            # Get all weather parsers:\n            parsers = await controller.parsers.current()\n\n            # Get all programs:\n            programs = await controller.programs.all()\n\n            # Include inactive programs:\n            programs = await controller.programs.all(include_inactive=True)\n\n            # Get a specific program:\n            program_1 = await controller.programs.get(1)\n\n            # Enable or disable a specific program:\n            await controller.programs.enable(1)\n            await controller.programs.disable(1)\n\n            # Get the next run time for all programs:\n            runs = await controller.programs.next()\n\n            # Get all running programs:\n            programs = await controller.programs.running()\n\n            # Start and stop a program:\n            await controller.programs.start(1)\n            await controller.programs.stop(1)\n\n            # Get basic details about all zones:\n            zones = await controller.zones.all()\n\n            # Get advanced details about all zones:\n            zones = await controller.zones.all(details=True)\n\n            # Include inactive zones:\n            zones = await controller.zones.all(include_inactive=True)\n\n            # Get basic details about a specific zone:\n            zone_1 = await controller.zones.get(1)\n\n            # Get advanced details about a specific zone:\n            zone_1 = await controller.zones.get(1, details=True)\n\n            # Enable or disable a specific zone:\n            await controller.zones.enable(1)\n            await controller.zones.disable(1)\n\n            # Start a zone for 60 seconds:\n            await controller.zones.start(1, 60)\n\n            # ...and stop it:\n            await controller.zones.stop(1)\n\n            # Get all running zones:\n            programs = await controller.zones.running()\n\n            # Get the device name:\n            name = await controller.provisioning.device_name\n\n            # Get all provisioning settings:\n            settings = await controller.provisioning.settings()\n\n            # Get all networking info related to the device:\n            wifi = await controller.provisioning.wifi()\n\n            # Get various types of active watering restrictions:\n            current = await controller.restrictions.current()\n            universal = await controller.restrictions.universal()\n            hourly = await controller.restrictions.hourly()\n            raindelay = await controller.restrictions.raindelay()\n\n            # Set universal restrictions \u2013 note that the payload is the same structure\n            # as returned by controller.restrictions.universal():\n            await controller.restrictions.set_universal(\n                {\n                    \"hotDaysExtraWatering\": False,\n                    \"freezeProtectEnabled\": True,\n                }\n            )\n\n            # Get watering stats:\n            today = await controller.stats.on_date(datetime.date.today())\n            upcoming_days = await controller.stats.upcoming(details=True)\n\n            # Get info on various watering activities not already covered:\n            log = await controller.watering.log(datetime.date.today(), 2)\n            queue = await controller.watering.queue()\n            runs = await controller.watering.runs(datetime.date.today())\n\n            # Pause all watering activities for 30 seconds:\n            await controller.watering.pause_all(30)\n\n            # Unpause all watering activities:\n            await controller.watering.unpause_all()\n\n            # Stop all watering activities:\n            await controller.watering.stop_all()\n\n            # See if a firmware update is available:\n            update_data = await controller.machine.get_firmware_update_status()\n            # ...and request the update:\n            update_data = await controller.machine.update_firmware()\n\n            # Reboot the controller:\n            update_data = await controller.machine.reboot()\n\n            # Return the current flow meter data:\n            flowmeter = await controller.watering.flowmeter()\n\n            # Add values to flowmeter counters from an external smart water meter\n            # not wired directly to the controller.\n            # Units can be \"clicks\", \"gal\", \"m3\" and \"litre\".\n            await controller.watering.post_flowmeter({\"value\": 2000, \"units\": \"clicks\"})\n\n\nasyncio.run(main())\n```\n\nCheck out `example.py`, the tests, and the source files themselves for method\nsignatures and more examples. For additional reference, the full RainMachine\u2122 API\ndocumentation is available [here][rainmachine-api].\n\n# Loading Controllers Multiple Times\n\nIt is technically possible to load a controller multiple times. Let's pretend\nfor a moment that:\n\n- We have a local controller named `Home` (available at `192.168.1.101`).\n- We have a remote controller named `Grandma's House`.\n- Both controllers live under our email address: `user@host.com`\n\nIf we load them thus:\n\n```python\nimport asyncio\n\nfrom aiohttp import ClientSession\n\nfrom regenmaschine import Client\n\n\nasync def main() -> None:\n    \"\"\"Run!\"\"\"\n    async with ClientSession() as session:\n        client = Client(session=session)\n\n        # Load \"Home\" locally:\n        await client.load_local(\"192.168.1.101\", \"my_password\")\n\n        # Load all of my controllers remotely:\n        await client.load_remote(\"user@host.com\", \"my_password\")\n\n\nasyncio.run(main())\n```\n\n...then we will have the following:\n\n1. `Home` will be a `LocalController` and accessible over the LAN.\n2. `Grandma's House` will be a `RemoteController` and accessible only over the\n   RainMachine\u2122 cloud.\n\nNotice that `regenmaschine` is smart enough to not overwrite a controller that\nalready exists: even though `Home` exists as a remote controller owned by\n`user@host.com`, it had already been loaded locally. By default,\n`regenmaschine` will only load a controller if it hasn't been loaded before\n(locally _or_ remotely). If you want to change this behavior, both `load_local`\nand `load_remote` accept an optional `skip_existing` parameter:\n\n```python\nimport asyncio\n\nfrom aiohttp import ClientSession\n\nfrom regenmaschine import Client\n\n\nasync def main() -> None:\n    \"\"\"Run!\"\"\"\n    async with ClientSession() as session:\n        client = Client(session=session)\n\n        # Load all of my controllers remotely:\n        await client.load_remote(\"user@host.com\", \"my_password\")\n\n        # Load \"Home\" locally, overwriting the existing remote controller:\n        await client.load_local(\"192.168.1.101\", \"my_password\", skip_existing=False)\n\n\nasyncio.run(main())\n```\n\n# Contributing\n\nThanks to all of [our contributors][contributors] so far!\n\n1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue].\n2. [Fork the repository][fork].\n3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv`\n4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate`\n5. Install the dev environment: `script/setup`\n6. Code your new feature or bug fix on a new branch.\n7. Write tests that cover your new functionality.\n8. Run tests and ensure 100% code coverage: `poetry run pytest --cov regenmaschine tests`\n9. Update `README.md` with any new documentation.\n10. Submit a pull request!\n\n[aiohttp]: https://github.com/aio-libs/aiohttp\n[ci-badge]: https://img.shields.io/github/actions/workflow/status/bachya/regenmaschine/test.yml\n[ci]: https://github.com/bachya/regenmaschine/actions\n[codecov-badge]: https://codecov.io/gh/bachya/regenmaschine/branch/dev/graph/badge.svg\n[codecov]: https://codecov.io/gh/bachya/regenmaschine\n[contributors]: https://github.com/bachya/regenmaschine/graphs/contributors\n[fork]: https://github.com/bachya/regenmaschine/fork\n[issues]: https://github.com/bachya/regenmaschine/issues\n[license-badge]: https://img.shields.io/pypi/l/regenmaschine.svg\n[license]: https://github.com/bachya/regenmaschine/blob/main/LICENSE\n[maintainability-badge]: https://api.codeclimate.com/v1/badges/cb14e60d5f5a4c2ccb2c/maintainability\n[maintainability]: https://codeclimate.com/github/bachya/regenmaschine/maintainability\n[new-issue]: https://github.com/bachya/regenmaschine/issues/new\n[pypi-badge]: https://img.shields.io/pypi/v/regenmaschine.svg\n[pypi]: https://pypi.python.org/pypi/regenmaschine\n[rainmachine-api]: https://rainmachine.docs.apiary.io/\n[rainmachine-premium]: https://www.rainmachine.com/premium/\n[regenmaschine]: http://www.rainmachine.com/\n[version-badge]: https://img.shields.io/pypi/pyversions/regenmaschine.svg\n[version]: https://pypi.python.org/pypi/regenmaschine\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple API for RainMachine sprinkler controllers",
    "version": "2024.3.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/bachya/regenmaschine/issues",
        "Changelog": "https://github.com/bachya/regenmaschine/releases",
        "Homepage": "https://github.com/bachya/regenmaschine",
        "Repository": "https://github.com/bachya/regenmaschine"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "83b05ab9b76eb667c338cc50e3a40d7114b121bb662d2f7551ca8054b8a51374",
                "md5": "c0a71bc45270e82dccae8ecb53cd495e",
                "sha256": "9d0c88a8a00ce9ea623ce799b74046932e73023ffda1bf008037fc8c31c739d8"
            },
            "downloads": -1,
            "filename": "regenmaschine-2024.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c0a71bc45270e82dccae8ecb53cd495e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<4.0",
            "size": 20945,
            "upload_time": "2024-03-11T15:30:55",
            "upload_time_iso_8601": "2024-03-11T15:30:55.586798Z",
            "url": "https://files.pythonhosted.org/packages/83/b0/5ab9b76eb667c338cc50e3a40d7114b121bb662d2f7551ca8054b8a51374/regenmaschine-2024.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "05e1e76f285c6cc6b144ef71d52ee081b6c1cbbf7b3af01f55c1e4f85407f37f",
                "md5": "12bf6a22488b705dadaf983011832ee6",
                "sha256": "e74b115bbedddff020b9981dc7d5546a3aeb12aa813136a51997984bc59a43cd"
            },
            "downloads": -1,
            "filename": "regenmaschine-2024.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "12bf6a22488b705dadaf983011832ee6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<4.0",
            "size": 18916,
            "upload_time": "2024-03-11T15:30:57",
            "upload_time_iso_8601": "2024-03-11T15:30:57.215207Z",
            "url": "https://files.pythonhosted.org/packages/05/e1/e76f285c6cc6b144ef71d52ee081b6c1cbbf7b3af01f55c1e4f85407f37f/regenmaschine-2024.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-11 15:30:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bachya",
    "github_project": "regenmaschine",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "regenmaschine"
}
        
Elapsed time: 0.21928s