Small python library and CLI script which allows running computers remotely on LAN.
Project description
Remly
Small python library and CLI script which allows running computers remotely on LAN.
Installation
pip install remly
Usage example
A few motivating and useful examples of how remly can be used.
CLI program
usage: remly [-h] {s,w} ...
Cli script allow turn on your computer remotely and check status
positional arguments:
{s,w} commands
s check device status (accept ipv4 and mac)
w wake up computer
optional arguments:
-h, --help show this help message and exit
Wake up device
remly w -m AA:AA:AA:AA:AA:AA
usage: remly w [-h] [--mac ETH_ADDR] [--port PORT] [--bcasts BCASTS [BCASTS ...]]
optional arguments:
-h, --help show this help message and exit
--mac ETH_ADDR, -m ETH_ADDR
device physical address
--port PORT, -p PORT port for WoL protocol (default: 9)
--bcasts BCASTS [BCASTS ...], -b BCASTS [BCASTS ...]
broadcast address (default: 192.168.0.255)
Check device status
remly s -m AA:AA:AA:AA:AA:AA
usage: remly s [-h] [--mac ETH_ADDR] [--ipv4 IP_ADDRESS] [--port PORT] [--timeout TIMEOUT]
optional arguments:
-h, --help show this help message and exit
--mac ETH_ADDR, -m ETH_ADDR
device physical address
--ipv4 IP_ADDRESS, -v4 IP_ADDRESS
device ipv4 address
--port PORT, -p PORT port for ICMP protocol (default: 7)
--timeout TIMEOUT, -t TIMEOUT
library
from remly import wake_up, status
# wake up device
wake_up(eth_addr='AA:AA:AA:AA:AA:AA', port=555, broadcast=['192.168.16.255'])
# check device status
# takes either an ip or a mac address
status(ip_address='192.168.16.5')
# based on physical address
status(eth_addr='2b:56:ff:d3:3f:31', timeout=5, port=1)
from remly import wake_up
known_computers = {
'dev1': '2b:56:ff:d3:3f:31',
'dev2': '60:f4:4c:53:9a:7f'
}
for __, dev in known_computers.items():
wake_up(eth_addr=dev, bcasts=['192.168.16.255'], port=9)
Release History
- 2.0
- code documentation.
- upgrade mac verification function to support more physical addresses formats.
- added future allows getting ip addres from mac (read_arptable).
- added checking device status function.
- 1.0.5
- fixed a startup bug.
- improve code.
- removing unnecessary class.
- 1.0.0
- release working program.
Meta
Piotr Markiewicz – @LinkedIn – sectasy0@gmail.coom
Distributed under the MIT license. See LICENSE
for more information.
Contributing
- Fork it (https://github.com/sectasy0/remly)
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes (
git commit -am 'Add some fooBar'
) - Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request
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
remly-2.0.0.tar.gz
(6.4 kB
view details)
Built Distribution
remly-2.0.0-py3-none-any.whl
(7.6 kB
view details)
File details
Details for the file remly-2.0.0.tar.gz
.
File metadata
- Download URL: remly-2.0.0.tar.gz
- Upload date:
- Size: 6.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbb8413d77642083ea534d4f9844be661c5f478b1d3d707b7ec96880fa3fe517 |
|
MD5 | be1f854dd1bb825d912815c68ae613ba |
|
BLAKE2b-256 | 820d970cc1a6a65f1be677373cb110a504898c5aa6beb17c45add246c2cd565a |
File details
Details for the file remly-2.0.0-py3-none-any.whl
.
File metadata
- Download URL: remly-2.0.0-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 181a9b31a67135d3736b5127afb718f9c66a170d725f887ad609ebfecbe73305 |
|
MD5 | 77a9379599185f908a3e291e7034f8c4 |
|
BLAKE2b-256 | 5adce1842e7aa1486b11c2b2ff3d752799657b316c4ef45dc83a2603f05e1ae9 |