Metadata-Version: 2.1
Name: spruce-sniffer
Version: 0.1.4
Summary: spruce sniffer is a versatile network sniffer
Home-page: https://github.com/Alopex4/spruce
Author: alopex cheung
Author-email: alopex4@163.com
License: MIT
Platform: UNKNOWN
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: Software Development :: Version Control :: Git
Description-Content-Type: text/markdown
Requires-Dist: PyQt5 (>=5.12.1)
Requires-Dist: requests (>=2.21.0)
Requires-Dist: netifaces (>=0.10.9)
Requires-Dist: numpy (>=1.11.0)
Requires-Dist: matplotlib (>=3.0.3)
Requires-Dist: scapy (==2.4.0)
Requires-Dist: psutil (>=3.4.2)
Requires-Dist: ptable (>=0.9.2)

# Spruce
> Spruce is a versatile network sniffer

Spruce is an mix network sniffer, it can monitor both 
your local network node flow also LAN  network nodes.  
Through ARP scan you can gather LAN nodes information 
swift and effortless, not only that the export format
is very rich.  

Like other sniffer, you can use spruce to capture 
packages and analysis them by one click. After capture
 finish you can save the package to `.pcap` format or 
 reopen it under spruce or other sniffer you like to 
 further processing.

Spruce support some intimate function to users. You can
`right click` your scan item to query some useful information
like `IP address belongs` and `Computer terms(protocol) query`
Of course, you can use this function individual or simultaneously
under capture packages. You can gather the figure after
capture stop, those figure is a visible resource make you
understand what packets you capture and how the network flow
during this period.


![start screen](https://github.com/Alopex4/spruce/blob/master/shoot/start.png)

## Installation

OS X & Linux:

```sh
pip3 install spurce-sniffer
```

## Usage example

```sh
sudo spruce-sniffer
```

Make sure under root privilege to run the software.

## Redistribute the software is permissible

You can built the software from source code to frozen distribute version.

```sh
# Example of `pyinstaller`

cd spruce
pyinstaller spruce.py   \
--hidden-import prettytable \
--hidden-import scapy   \
--hidden-import request \
--hidden-import ctype   \
--hidden-import netifaces   \
--add-data icon/\*.ico:icon \
--add-data static/help.html:static \
--add-data static/oui.csv:static 

```

## Release History

* 0.1.0
    * The first proper release
    * date: Mon Apr  8 14:27:17 CST 2019

## Meta

alopex cheung – alopex4@163.com

Distributed under the `MIT` license. See ``LICENSE`` for more information.

[spruce under license](https://github.com/Alopex4/spruce/blob/master/LICENSE)

## Contributing

1. Fork it (<https://github.com/Alopex4/spruce>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request


