{"id":24091206,"url":"https://github.com/bateman/wolproxypycli","last_synced_at":"2025-05-06T23:25:39.987Z","repository":{"id":42512755,"uuid":"439546885","full_name":"bateman/wolproxypycli","owner":"bateman","description":"A PyPI module and Typer (CLI) app for sending Wake-On-LAN packets","archived":false,"fork":false,"pushed_at":"2024-05-21T07:33:20.000Z","size":632,"stargazers_count":1,"open_issues_count":7,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T20:27:11.722Z","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/bateman.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-18T06:40:06.000Z","updated_at":"2024-02-09T11:58:15.000Z","dependencies_parsed_at":"2024-02-07T23:29:19.310Z","dependency_job_id":"2ecadae8-3da5-495c-bde0-4e3c49df4973","html_url":"https://github.com/bateman/wolproxypycli","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bateman%2Fwolproxypycli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bateman%2Fwolproxypycli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bateman%2Fwolproxypycli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bateman%2Fwolproxypycli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bateman","download_url":"https://codeload.github.com/bateman/wolproxypycli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252784634,"owners_count":21803723,"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":"2025-01-10T07:13:09.079Z","updated_at":"2025-05-06T23:25:39.966Z","avatar_url":"https://github.com/bateman.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wolproxypycli\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wolproxypycli)\n![GitHub](https://img.shields.io/github/license/bateman/wolproxypycli)\n[![GitHub](https://github.com/bateman/wolproxypycli/actions/workflows/release.yml/badge.svg)](https://github.com/bateman/wolproxypycli/actions/workflows/release.yml)\n[![Documentation Status](https://readthedocs.org/projects/wolproxypycli/badge/?version=latest)](https://wolproxypycli.readthedocs.io/en/latest/?badge=latest)\n![PyPI](https://img.shields.io/pypi/v/wolproxypycli)\n![PyPI - Format](https://img.shields.io/pypi/format/wolproxypycli)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/wolproxypycli)\n\n\n![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/bateman/wolproxypycli)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat\u0026labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)\n[![Known Vulnerabilities](https://snyk.io/test/github/bateman/wolproxypycli/badge.svg)](https://snyk.io/test/github/bateman/wolproxypycli)\n\nA PyPI module and Typer (CLI) app for sending Wake-On-LAN packets\n\n## Development environment installation\n\nThis 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:\n\n```bash\npoetry install\n```\n\nor\n\n```bash\nmake install\n```\n\n## Production environment installation\nTo install the package from source without the development dependencies, run:\n\n```bash\nmake production\n```\n\n\n## Usage\n\nWake on lan must be enabled on the target host device before usage.\n\nFor more details, check the [documentation](https://wolproxypycli.readthedocs.io/en/latest).\n\n### Command line\n\nThis tool is typically used to send a Wake-on-LAN packet to a device on your network. The `\u003cMAC\u003e` argument should be replaced with the MAC address of the device you want to wake up.\n\nHere's an example:\n\n```bash\npoetry run wolproxypycli 00:11:22:33:44:55\n```\n\nTo see the full list of options, run:\n\n```bash\npoetry run wolproxypycli --help\n```\n\n```\n╭─ Arguments ──────────────────────────────────────────────────────╮\n│ * mac                 TEXT     [default: None] [required]        │\n╰──────────────────────────────────────────────────────────────────╯\n╭─ Options ────────────────────────────────────────────────────────╮\n│ --ip                  TEXT     [default: 255.255.255.255]        │\n│ --port                INTEGER  [default: 9]                      │\n│ --interface           TEXT     [default: None]                   │\n│ --install-completion  Install completion for the current shell.  │\n│ --show-completion     Show completion for the current shell.     │\n│ --help                Show this message and exit.                │\n╰──────────────────────────────────────────────────────────────────╯\n```\n\n### Module\n\nFirst, make sure to install the module via `poetry`:\n\n```bash\npoetry add wolproxypycli\n```\n\nor `pip`:\n\n```bash\npip install wolproxypycli\n```\n\nHere's a basic example of how to use `wolproxypycli`:\n\n```python\nfrom wolproxypycli import wol\n...\n\nwol.send(mac=\"AA:BB:CC:DD:EE:FF\")\n```\n\n## License\n\nThis project is licensed under the terms of the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbateman%2Fwolproxypycli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbateman%2Fwolproxypycli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbateman%2Fwolproxypycli/lists"}