https://github.com/bateman/wolproxypycli

A PyPI module and Typer (CLI) app for sending Wake-On-LAN packets
https://github.com/bateman/wolproxypycli

Last synced: about 1 year ago
JSON representation

A PyPI module and Typer (CLI) app for sending Wake-On-LAN packets

• Host: GitHub
• URL: https://github.com/bateman/wolproxypycli
• Owner: bateman
• License: mit
• Created: 2021-12-18T06:40:06.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T07:33:20.000Z (about 2 years ago)
• Last Synced: 2025-04-13T20:27:11.722Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 617 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# wolproxypycli

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wolproxypycli)

![GitHub](https://img.shields.io/github/license/bateman/wolproxypycli)

[![GitHub](https://github.com/bateman/wolproxypycli/actions/workflows/release.yml/badge.svg)](https://github.com/bateman/wolproxypycli/actions/workflows/release.yml)

[![Documentation Status](https://readthedocs.org/projects/wolproxypycli/badge/?version=latest)](https://wolproxypycli.readthedocs.io/en/latest/?badge=latest)

![PyPI](https://img.shields.io/pypi/v/wolproxypycli)

![PyPI - Format](https://img.shields.io/pypi/format/wolproxypycli)

![PyPI - Downloads](https://img.shields.io/pypi/dm/wolproxypycli)

![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/bateman/wolproxypycli)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)

[![Known Vulnerabilities](https://snyk.io/test/github/bateman/wolproxypycli/badge.svg)](https://snyk.io/test/github/bateman/wolproxypycli)

A PyPI module and Typer (CLI) app for sending Wake-On-LAN packets

## Development environment installation

This project uses [Poetry](https://python-poetry.org/) for dependency management. To install the project, first install `poetry`, then run the following command in the project root directory:

```bash

poetry install

```

or

```bash

make install

```

## Production environment installation

To install the package from source without the development dependencies, run:

```bash

make production

```

## Usage

Wake on lan must be enabled on the target host device before usage.

For more details, check the [documentation](https://wolproxypycli.readthedocs.io/en/latest).

### Command line

This tool is typically used to send a Wake-on-LAN packet to a device on your network. The `` argument should be replaced with the MAC address of the device you want to wake up.

Here's an example:

```bash

poetry run wolproxypycli 00:11:22:33:44:55

```

To see the full list of options, run:

```bash

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`:

```bash

poetry add wolproxypycli

```

or `pip`:

```bash

pip install wolproxypycli

```

Here's a basic example of how to use `wolproxypycli`:

```python

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](LICENSE).