{"id":19341588,"url":"https://github.com/sectasy0/remly","last_synced_at":"2025-09-12T05:40:43.266Z","repository":{"id":46595702,"uuid":"338023992","full_name":"sectasy0/remly","owner":"sectasy0","description":"Small python library and CLI script which allows running computers remotely on LAN using WoL protocol.","archived":false,"fork":false,"pushed_at":"2022-07-18T21:11:05.000Z","size":30,"stargazers_count":17,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-19T02:29:12.276Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sectasy0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-11T12:34:13.000Z","updated_at":"2024-01-26T21:23:38.000Z","dependencies_parsed_at":"2022-09-26T21:50:52.251Z","dependency_job_id":null,"html_url":"https://github.com/sectasy0/remly","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sectasy0%2Fremly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sectasy0%2Fremly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sectasy0%2Fremly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sectasy0%2Fremly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sectasy0","download_url":"https://codeload.github.com/sectasy0/remly/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250365733,"owners_count":21418737,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T03:31:33.886Z","updated_at":"2025-04-23T03:31:56.386Z","avatar_url":"https://github.com/sectasy0.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Remly (Wake On Lan)\r\n\u003e Small python library and CLI script which allows running computers remotely on LAN using WoL protocol.\r\n\r\n![Python version][python-image]\r\n\r\n## Installation\r\n\r\n```sh\r\npip install remly\r\n```\r\n\r\n## Usage example\r\n\r\nA few motivating and useful examples of how remly can be used.\r\n\r\n#### CLI program\r\n\r\n```sh\r\nusage: remly [-h] {s,w} ...\r\n\r\nCli script allow turn on your computer remotely and check status\r\n\r\npositional arguments:\r\n  {s,w}       commands\r\n    s         check device status (accept ipv4 and mac)\r\n    w         wake up computer\r\n\r\noptional arguments:\r\n  -h, --help  show this help message and exit\r\n```\r\n\r\nWake up device\r\n```sh\r\nremly w -m AA:AA:AA:AA:AA:AA\r\n```\r\n\r\n```sh\r\nusage: remly w [-h] [--mac ETH_ADDR] [--port PORT] [--bcasts BCASTS [BCASTS ...]]\r\n\r\noptional arguments:\r\n  -h, --help            show this help message and exit\r\n  --mac ETH_ADDR, -m ETH_ADDR\r\n                        device physical address\r\n  --port PORT, -p PORT  port for WoL protocol (default: 9)\r\n  --bcasts BCASTS [BCASTS ...], -b BCASTS [BCASTS ...]\r\n                        broadcast address (default: 192.168.0.255)\r\n```\r\n\r\nCheck device status\r\n```\r\nremly s -m AA:AA:AA:AA:AA:AA\r\n```\r\n\r\n```sh\r\nusage: remly s [-h] [--mac ETH_ADDR] [--ipv4 IP_ADDRESS] [--port PORT] [--timeout TIMEOUT]\r\n\r\noptional arguments:\r\n  -h, --help            show this help message and exit\r\n  --mac ETH_ADDR, -m ETH_ADDR\r\n                        device physical address\r\n  --ipv4 IP_ADDRESS, -v4 IP_ADDRESS\r\n                        device ipv4 address\r\n  --port PORT, -p PORT  port for ICMP protocol (default: 7)\r\n  --timeout TIMEOUT, -t TIMEOUT\r\n```\r\n\r\n#### library\r\n```python\r\nfrom remly import wake_up, status\r\n\r\n# wake up device\r\nwake_up(eth_addr='AA:AA:AA:AA:AA:AA', port=555, broadcast=['192.168.16.255'])\r\n\r\n# check device status\r\n# takes either an ip or a mac address\r\nstatus(ip_address='192.168.16.5')\r\n\r\n# based on physical address\r\nstatus(eth_addr='2b:56:ff:d3:3f:31', timeout=5, port=1)\r\n\r\n```\r\n```python\r\nfrom remly import wake_up\r\n\r\nknown_computers = {\r\n    'dev1': '2b:56:ff:d3:3f:31',\r\n    'dev2': '60:f4:4c:53:9a:7f'\r\n}\r\n\r\nfor __, dev in known_computers.items():\r\n    wake_up(eth_addr=dev, bcasts=['192.168.16.255'], port=9)\r\n\r\n```\r\n\r\n## Release History\r\n\r\n* 2.0\r\n    * code documentation.\r\n    * upgrade mac verification function to support more physical addresses formats.\r\n    * added future allows getting ip addres from mac (read_arptable).\r\n    * added checking device status function.\r\n* 1.0\r\n    * release working program.\r\n\r\n## Meta\r\n\r\nPiotr Markiewicz – [@LinkedIn](https://www.linkedin.com/in/piotr-markiewicz-a44b491b1/) – sectasy0@gmail.coom\r\n\r\nDistributed under the MIT license. See ``LICENSE`` for more information.\r\n\r\n[https://github.com/sectasy0](https://github.com/sectasy0)\r\n\r\n## Contributing\r\n\r\n1. Fork it (\u003chttps://github.com/sectasy0/remly\u003e)\r\n2. Create your feature branch (`git checkout -b feature/fooBar`)\r\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\r\n4. Push to the branch (`git push origin feature/fooBar`)\r\n5. Create a new Pull Request\r\n\r\n\u003c!-- Markdown link \u0026 img dfn's --\u003e\r\n[python-image]: https://img.shields.io/badge/python-3.8-blue\r\n[pypi-image]: https://img.shields.io/badge/pypi-remly-blue\r\n[pypi-url]:  pypi.org/project/remly/\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsectasy0%2Fremly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsectasy0%2Fremly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsectasy0%2Fremly/lists"}