File pywakeonlan-1.1.6.obscpio of Package python-wakeonlan

Overview Repositories Revisions Requests Users Attributes Meta

File pywakeonlan-1.1.6.obscpio of Package python-wakeonlan (Revision 7a5f2cf06cd09ef04beec7814a2ccc93)

Currently displaying revision 7a5f2cf06cd09ef04beec7814a2ccc93 , Show latest

07070100000000000081A4000003E800000064000000015AB7B43B0000020E000000000000000000000000000000000000001E00000000pywakeonlan-1.1.6/.travis.ymllanguage: python
python:
- '2.7'
- '3.4'
- '3.5'
- '3.6'
git:
  depth: false
install: pip install codecov gitchangelog tox-travis
script: tox
after_success:
- codecov
- export CHANGELOG=$(gitchangelog $(git describe --abbrev=0 --tags HEAD^)..HEAD)
deploy:
- provider: pypi
  distributions: sdist bdist_wheel
  user: $TWINE_USERNAME
  password: $TWINE_PASSWORD
  on:
    tags: true
    python: '3.6'
- provider: releases
  api_key: $GITHUB_OAUTH_TOKEN
  file: dist/*
  skip_cleanup: true
  on:
    tags: true
    python: '3.6'
07070100000001000081A4000003E800000064000000015AB7B43B00000447000000000000000000000000000000000000001A00000000pywakeonlan-1.1.6/LICENSEMIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
07070100000002000081A4000003E800000064000000015AB7B43B00000A7E000000000000000000000000000000000000001D00000000pywakeonlan-1.1.6/README.rst#########
wakeonlan
#########

.. image:: https://img.shields.io/pypi/v/wakeonlan.svg
   :target: https://pypi.org/project/wakeonlan/
   :alt: Pypi version

.. image:: https://img.shields.io/pypi/pyversions/wakeonlan.svg
   :target: https://pypi.org/project/wakeonlan/#files
   :alt: Supported Python versions

.. image:: https://img.shields.io/travis/remcohaszing/pywakeonlan/master.svg
    :target: https://travis-ci.org/remcohaszing/pywakeonlan
    :alt: Build Status

.. image:: https://readthedocs.org/projects/pywakeonlan/badge/?version=latest
    :target: https://pywakeonlan.readthedocs.io/en/latest
    :alt: Documentation Status

.. image:: https://codecov.io/gh/remcohaszing/pywakeonlan/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/remcohaszing/pywakeonlan
   :alt: Code coverage

A small python module for wake on lan.

For more information on the wake on lan protocol please take a look at
Wikipedia_.

*****
Usage
*****

To wake up a computer using wake on lan it must first be enabled in the BIOS
settings. Please note the computer you are trying to power on does not have an
ip address, but it does have a mac address. The package needs to be sent as a
broadcast package.

******************
As a python module
******************

- Import the module

>>> from wakeonlan import send_magic_packet

- Wake up a single computer by its mac address

>>> send_magic_packet('ff.ff.ff.ff.ff.ff')

- Wake up multiple computers by their mac addresses.

>>> send_magic_packet('ff.ff.ff.ff.ff.ff', '00-00-00-00-00-00',
...                   'FFFFFFFFFFFF')

- An external host may be specified. Do note that port forwarding on that host
  is required. The default ip address is 255.255.255.255 and the default port
  is 9.

>>> send_magic_packet('ff.ff.ff.ff.ff.ff',
...                   ip_address='example.com',
...                   port=1337)

**********************
As a standalone script
**********************

usage: wakeonlan [-h] [-i ip] [-p port] mac address [mac address ...]

Wake one or more computers using the wake on lan protocol.

positional arguments:
      mac address  The mac addresses or of the computers you are trying to wake.

optional arguments:
      -h, --help   show this help message and exit
      -i ip        The ip address of the host to send the magic packet to.
                   (default 255.255.255.255)
      -p port      The port of the host to send the magic packet to (default 9)

************
Dependencies
************

- Python2.x or Python3.x

*******
License
*******

MIT

.. _GitHub: https://github.com/remcohaszing/pywakeonlan
.. _Wikipedia: http://en.wikipedia.org/wiki/Wake-on-LAN
07070100000003000081A4000003E800000064000000015AB7B43B00000032000000000000000000000000000000000000002700000000pywakeonlan-1.1.6/dev-requirements.txtmock ~= 2.0.0
pytest ~= 3.4.0
pytest-cov ~= 2.5.1
07070100000004000041ED000003E800000064000000025AB7B43B00000000000000000000000000000000000000000000001700000000pywakeonlan-1.1.6/docs07070100000005000081A4000003E800000064000000015AB7B43B00000059000000000000000000000000000000000000002300000000pywakeonlan-1.1.6/docs/apidocs.rst###############
Python api docs
###############

.. automodule:: wakeonlan
    :members:
07070100000006000081A4000003E800000064000000015AB7B43B0000022A000000000000000000000000000000000000001F00000000pywakeonlan-1.1.6/docs/conf.py"""
Configuration for the documentation generation.

"""
import pkg_resources

project = 'wakeonlan'
_dist = pkg_resources.get_distribution(project)

version = _dist.parsed_version.base_version
release = _dist.version
copyright = '2012, Remco Haszing'

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.napoleon',
]

intersphinx_mapping = {
    'python': ('https://docs.python.org/3.6', None),
}

nitpicky = True

default_role = 'any'
todo_include_todos = True

master_doc = 'index'
html_theme = 'sphinx_rtd_theme'
07070100000007000081A4000003E800000064000000015AB7B43B00000049000000000000000000000000000000000000002100000000pywakeonlan-1.1.6/docs/index.rst###########
Pywakeonlan
###########

.. toctree::
    readme
    apidocs
07070100000008000081A4000003E800000064000000015AB7B43B0000001B000000000000000000000000000000000000002200000000pywakeonlan-1.1.6/docs/readme.rst.. include:: ../README.rst
07070100000009000081A4000003E800000064000000015AB7B43B0000002A000000000000000000000000000000000000002800000000pywakeonlan-1.1.6/docs/requirements.txtSphinx ~= 1.6.6
sphinx-rtd-theme ~= 0.2.4
0707010000000A000081A4000003E800000064000000015AB7B43B000000C2000000000000000000000000000000000000002A00000000pywakeonlan-1.1.6/flake8-requirements.txtflake8 ~= 3.5.0
flake8-commas ~= 1.0.0
flake8-comprehensions ~= 1.4.1
flake8-docstrings ~= 1.3.0
flake8-import-order ~= 0.16.0
flake8-print ~= 3.0.1
flake8-quotes ~= 0.13.0
pep8-naming ~= 0.5.0
0707010000000B000081A4000003E800000064000000015AB7B43B00000097000000000000000000000000000000000000001C00000000pywakeonlan-1.1.6/setup.cfg[metadata]
license_file = LICENSE

[bdist_wheel]
universal = 1

[coverage:run]
branch = true
source = wakeonlan

[coverage:report]
show_missing = true
0707010000000C000081ED000003E800000064000000015AB7B43B0000052C000000000000000000000000000000000000001B00000000pywakeonlan-1.1.6/setup.py#!/usr/bin/env python
# -*- encoding: utf-8 -*-
"""
Install the wakeonlan module.

"""
from setuptools import setup

with open('README.rst') as f:
    readme = f.read()

setup(
    name='wakeonlan',
    description='A small python module for wake on lan.',
    project_urls={
        'Documentation': 'http://pywakeonlan.readthedocs.io',
        'GitHub': 'https://github.com/remcohaszing/pywakeonlan',
    },
    author='Remco Haszing',
    author_email='remcohaszing@gmail.com',
    py_modules=['wakeonlan'],
    license='MIT',
    long_description=readme,
    use_scm_version=True,
    setup_requires=['setuptools-scm ~= 1.15.7'],
    classifiers=[
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'Intended Audience :: System Administrators',
        'License :: OSI Approved :: MIT License',
        'Operating System :: OS Independent',
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
        'Topic :: System :: Networking',
    ],
    entry_points={
        'console_scripts': ['wakeonlan = wakeonlan:main'],
    })
0707010000000D000081A4000003E800000064000000015AB7B43B0000171A000000000000000000000000000000000000002400000000pywakeonlan-1.1.6/test_wakeonlan.py"""
Tests for wakeonlan.

"""
import socket

import pytest
from mock import call
from mock import patch

from wakeonlan import create_magic_packet
from wakeonlan import main
from wakeonlan import send_magic_packet

@pytest.mark.parametrize('mac,packet', [
    ('000000000000',
     b'\xff\xff\xff\xff\xff\xff'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'
     b'\x00\x00\x00\x00\x00\x00'),
    ('01:23:45:67:89:ab',
     b'\xff\xff\xff\xff\xff\xff'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'
     b'\x01#Eg\x89\xab'),
    ('ff-ff-ff-ff-ff-ff',
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'
     b'\xff\xff\xff\xff\xff\xff'),
], ids=['no separator', 'colons', 'hyphens'])
def test_create_magic_packet(mac, packet):
    """
    Test whether a correct magic packet is created.

"""
    result = create_magic_packet(mac)
    assert result == packet

@patch('socket.socket')
def test_send_magic_packet(sock):
    """
    Test whether the magic packets are broadcasted to the specified network.

"""
    send_magic_packet(
        '133713371337', '00-00-00-00-00-00', ip_address='example.com', port=7)
    assert sock.mock_calls == [
        call(socket.AF_INET, socket.SOCK_DGRAM),
        call().setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1),
        call().connect(('example.com', 7)),
        call().send(
            b'\xff\xff\xff\xff\xff\xff'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'),
        call().send(
            b'\xff\xff\xff\xff\xff\xff'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'),
        call().close(),
    ]

@patch('socket.socket')
def test_send_magic_packet_default(sock):
    """
    Test whether the magic packets are broadcasted using default values.

"""
    send_magic_packet('133713371337', '00-00-00-00-00-00')
    assert sock.mock_calls == [
        call(socket.AF_INET, socket.SOCK_DGRAM),
        call().setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1),
        call().connect(('255.255.255.255', 9)),
        call().send(
            b'\xff\xff\xff\xff\xff\xff'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'
            b'\x137\x137\x137'),
        call().send(
            b'\xff\xff\xff\xff\xff\xff'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'
            b'\x00\x00\x00\x00\x00\x00'),
        call().close(),
    ]

@patch('wakeonlan.send_magic_packet')
def test_main(send_magic_packet):
    """
    Test if processed arguments are passed to send_magic_packet.

"""
    main(['00:11:22:33:44:55', '-i', 'host.example', '-p', '1337'])
    assert send_magic_packet.mock_calls == [call(
        '00:11:22:33:44:55',
        ip_address='host.example',
        port=1337,
    )]
0707010000000E000081A4000003E800000064000000015AB7B43B000001DF000000000000000000000000000000000000001A00000000pywakeonlan-1.1.6/tox.ini[tox]
envlist = py{27,34,35,36},flake8,docs

[travis]
python =
  3.6: py36, docs, flake8

[testenv]
commands = pytest --cov
deps = -rdev-requirements.txt

[testenv:docs]
basepython = python3
commands = sphinx-build -a -W -E docs docs/_build
deps = -rdocs/requirements.txt

[testenv:flake8]
commands = flake8
basepython = python3
deps = -rflake8-requirements.txt

[flake8]
doctests = true
ignore = D105,D200,D204
import-order-style = smarkets
application-import-names = wakeonlan
0707010000000F000081ED000003E800000064000000015AB7B43B00000C67000000000000000000000000000000000000001F00000000pywakeonlan-1.1.6/wakeonlan.py#!/usr/bin/env python
# -*- encoding: utf-8 -*-
"""
Small module for use with the wake on lan protocol.

"""
from __future__ import absolute_import
from __future__ import unicode_literals

import argparse
import socket
import struct

BROADCAST_IP = '255.255.255.255'
DEFAULT_PORT = 9

def create_magic_packet(macaddress):
    """
    Create a magic packet.

A magic packet is a packet that can be used with the for wake on lan
    protocol to wake up a computer. The packet is constructed from the
    mac address given as a parameter.

Args:
        macaddress (str): the mac address that should be parsed into a
            magic packet.

"""
    if len(macaddress) == 12:
        pass
    elif len(macaddress) == 17:
        sep = macaddress[2]
        macaddress = macaddress.replace(sep, '')
    else:
        raise ValueError('Incorrect MAC address format')

# Pad the synchronization stream
    data = b'FFFFFFFFFFFF' + (macaddress * 16).encode()
    send_data = b''

# Split up the hex values in pack
    for i in range(0, len(data), 2):
        send_data += struct.pack(b'B', int(data[i: i + 2], 16))
    return send_data

def send_magic_packet(*macs, **kwargs):
    """
    Wake up computers having any of the given mac addresses.

Wake on lan must be enabled on the host device.

Args:
        macs (str): One or more macaddresses of machines to wake.

Keyword Args:
        ip_address (str): the ip address of the host to send the magic packet
                     to (default "255.255.255.255")
        port (int): the port of the host to send the magic packet to
               (default 9)

"""
    packets = []
    ip = kwargs.pop('ip_address', BROADCAST_IP)
    port = kwargs.pop('port', DEFAULT_PORT)
    for k in kwargs:
        raise TypeError('send_magic_packet() got an unexpected keyword '
                        'argument {!r}'.format(k))

for mac in macs:
        packet = create_magic_packet(mac)
        packets.append(packet)

sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
    sock.connect((ip, port))
    for packet in packets:
        sock.send(packet)
    sock.close()

def main(argv=None):
    """
    Run wake on lan as a CLI application.

"""
    parser = argparse.ArgumentParser(
        description='Wake one or more computers using the wake on lan'
                    ' protocol.')
    parser.add_argument(
        'macs',
        metavar='mac address',
        nargs='+',
        help='The mac addresses or of the computers you are trying to wake.')
    parser.add_argument(
        '-i',
        metavar='ip',
        default=BROADCAST_IP,
        help='The ip address of the host to send the magic packet to.'
             ' (default {})'.format(BROADCAST_IP))
    parser.add_argument(
        '-p',
        metavar='port',
        type=int,
        default=DEFAULT_PORT,
        help='The port of the host to send the magic packet to (default 9)')
    args = parser.parse_args(argv)
    send_magic_packet(*args.macs, ip_address=args.i, port=args.p)

if __name__ == '__main__':  # pragma: nocover
    main()
07070100000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000B00000000TRAILER!!!37 blocks

Places

File pywakeonlan-1.1.6.obscpio of Package python-wakeonlan (Revision 7a5f2cf06cd09ef04beec7814a2ccc93)

Places