pywol 0.3.0

A Wake-on-LAN tool written in Python.

Pywol

A Wake-on-LAN tool written in Python.

Pywol allows for starting up WoL-enabled systems over a network¹, and can either be used as a CLI tool or imported for use in other Python code.

Installation

    $ pip install pywol

Usage examples

As a CLI tool:

    $ pywol 1A:2B:3C:4D:5E:6F --ip 192.168.1.255 --v
    Waking '1A:2B:3C:4D:5E:6F' at 192.168.1.255:9...
    $
    $ pywol --help
    Usage: pywol [OPTIONS] MAC_ADDRESS

    CLI for the pywol package.

    Prefer specifying the broadcast IPv4 address of the target host subnet
    over the default '255.255.255.255'.

    Options:
    --ip_address, --ip TEXT  IPv4 broadcast address of target subnet.  [default:
                            255.255.255.255]
    --port, --p INTEGER      Target port.  [default: 9]
    --verbose, --v
    --help                   Show this message and exit.

Imported for use in other code:

    from pywol import wake
    wake("1A:2B:3C:4D:5E:6F", ip_address="192.168.1.255")

Why create another WoL tool?

I needed one and this was an opportunity to learn some stuff.

TODO

• Documentation
• Support for multiple target hosts
• Support for loading input from file

Meta

Erik R Berlin – [e-mail]

Distributed under the MIT license. See LICENSE for more information.

https://github.com/erberlin/pywol

---

1. Provided that any routers between the client and target hosts are configured to forward broadcast packets.