A PyPI module and Typer (CLI) app for sending Wake-On-LAN packets
Project description
wolproxypycli
A PyPI module and Typer (CLI) app for sending Wake-On-LAN packets
Installation
This project uses Poetry for dependency management. To install the project, first install poetry
, then run the following command in the project root directory:
poetry install
or
make install
Development installation
To install the package with all development dependencies, run:
make install-dev
Usage
Wake on lan must be enabled on the target host device before usage.
For more details, check the documentation.
Command line
This tool is typically used to send a Wake-on-LAN packet to a device on your network. The <MAC>
argument should be replaced with the MAC address of the device you want to wake up.
Here's an example:
poetry run wolproxypycli 00:11:22:33:44:55
To see the full list of options, run:
poetry run wolproxypycli --help
╭─ Arguments ──────────────────────────────────────────────────────╮
│ * mac TEXT [default: None] [required] │
╰──────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────╮
│ --ip TEXT [default: 255.255.255.255] │
│ --port INTEGER [default: 9] │
│ --interface TEXT [default: None] │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────╯
Module
First, make sure to install the module via poetry
:
poetry add wolproxypycli
or pip
:
pip install wolproxypycli
Here's a basic example of how to use wolproxypycli
:
from wolproxypycli import wol
...
wol.send(mac="AA:BB:CC:DD:EE:FF")
License
This project is licensed under the terms of the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wolproxypycli-0.1.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c970e24c1b3fba61c9cda8d57f024723bca4b3d265a12d229e326639fa198cdf |
|
MD5 | 76d02e06c9d99dba45ddac40ee879ff3 |
|
BLAKE2b-256 | 1d0d123b122f784979303a151d448c9225697dd22480938446c5c0e65f033691 |