Metadata-Version: 2.1
Name: arpwitch
Version: 0.3.9
Summary: A modern arpwatch replacement with JSON formatted outputs and easy options to exec commands when network changes are observed.
Home-page: https://arpwitch.readthedocs.io/
Author: Nicholas de Jong
Author-email: contact@nicholasdejong.com
License: BSD2
Keywords: arpwitch,arpwatch,arp,network,security
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Information Technology
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.6.0,<4.0.0
Description-Content-Type: text/markdown
License-File: LICENSE

# arpwitch

[![PyPi](https://img.shields.io/pypi/v/arpwitch.svg)](https://pypi.python.org/pypi/arpwitch/)
[![Python Versions](https://img.shields.io/pypi/pyversions/arpwitch.svg)](https://github.com/verbnetworks/arpwitch/)
[![Build Tests](https://github.com/verbnetworks/arpwitch/actions/workflows/build-tests.yml/badge.svg)](https://github.com/verbnetworks/arpwitch/actions/workflows/build-tests.yml)
[![Read the Docs](https://img.shields.io/readthedocs/arpwitch)](https://arpwitch.readthedocs.io)
![License](https://img.shields.io/github/license/verbnetworks/arpwitch.svg)

A modern arpwatch replacement with JSON formatted outputs and easy options to exec commands when network changes are 
observed.

Includes a convenience `--exec` definition to invoke nmap when new network-addresses are observed.

## Features
* Uses the Python `scapy` module to watch for network ARPs
* Filter ARP events based on new addresses only, or select all ARP events
* Easy to define `--exec` actions on arp related events
* Quick to use `--nmap` action to invoke nmap if installed, easy network device landscaping.
* Lookup of hardware addresses against the OUI database for manufacturer resolution.
* Logging available to STDERR
* Easy installation using PyPI `pip`
* Plenty of documentation and examples - https://arpwitch.readthedocs.io

## Installation
```shell
user@computer:~$ pip install arpwitch
```

## Command line usage
Use arpwitch to nmap all new hosts on the network
```shell
user@computer:~$ arpwitch --nmap --datafile /tmp/arpwitch.dat
```

## Project
* Github - [github.com/verbnetworks/arpwitch](https://github.com/verbnetworks/arpwitch)
* PyPI - [pypi.python.org/pypi/arpwitch](https://pypi.python.org/pypi/arpwitch/)
* ReadTheDocs - [arpwitch.readthedocs.io](https://arpwitch.readthedocs.io)

---
Copyright &copy; 2021 Nicholas de Jong


