Metadata-Version: 1.1
Name: arpreq
Version: 0.2.1
Summary: Query the Kernel ARP cache for the MAC address corresponding to IP address
Home-page: https://github.com/sebschrader/python-arpreq
Author: Sebastian Schrader
Author-email: sebastian.schrader@ossmail.de
License: MIT
Description: arpreq
        ======
        
        .. image:: https://travis-ci.org/sebschrader/python-arpreq.svg?branch=master
            :target: https://travis-ci.org/sebschrader/python-arpreq
        .. image:: https://img.shields.io/pypi/v/arpreq.svg?maxAge=2592000
            :target: https://pypi.python.org/pypi/arpreq
        .. image:: https://img.shields.io/pypi/pyversions/arpreq.svg?maxAge=2592000
            :target: https://pypi.python.org/pypi/arpreq
        .. image:: https://img.shields.io/pypi/wheel/arpreq.svg?maxAge=2592000
            :target: https://pypi.python.org/pypi/arpreq
        .. image:: https://img.shields.io/pypi/l/arpreq.svg?maxAge=2592000
            :target: https://pypi.python.org/pypi/arpreq
        
        Python C extension to query the Kernel ARP cache for the MAC address of
        a given IP address.
        
        Usage
        -----
        
        The ``arpreq`` module exposes a single function ``arpreq``, that will
        resolve a given IPv4 address into a MAC address.
        
        An IP address can only be resolved to a MAC address if it is on the same
        subnet as your machine.
        
        Let's assume your current machine has the address ``192.168.1.10`` and
        another machine with the address ``192.168.1.1`` is on the same subnet:
        
        .. code:: python
        
            >>> import arpreq
            >>> arpreq.arpreq('192.168.1.1')
            '00:11:22:33:44:55'
        
        If a IP address can not be resolved to an MAC address, None is returned.
        
        .. code:: python
        
            >>> arpreq.arpreq('8.8.8.8') is None
            True
        
        IP addresses may be also be specified as int or rich IP address data type
        of the common ``ipaddr``, ``ipaddress``, or ``netaddr`` modules.
        
        .. code:: python
        
            >>> arpreq.arpreq(0x7F000001)
            '00:00:00:00:00:00'
            >>> import netaddr
            >>> arpreq.arpreq(netaddr.IPAddress('127.0.0.1'))
            '00:00:00:00:00:00'
            >>> import ipaddr # on Python 2
            >>> arpreq.arpreq(ipaddr.IPv4Address('127.0.0.1'))
            '00:00:00:00:00:00'
            >>> import ipaddress # on Python 3
            >>> arpreq.arpreq(ipaddress.IPv4Address('127.0.0.1'))
            '00:00:00:00:00:00'
        
        Supported Platforms
        -------------------
        
        This extension has only been tested on Linux, it should however work on
        any platform that supports the ``SIOCGARP`` ioctl, which is virtually
        every BSD, Linux and Mac OS.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: System :: Networking
