Metadata-Version: 2.1
Name: lanscape
Version: 1.2.6a3
Summary: A python based local network scanner
Author-email: Michael Dennis <michael@dipduo.com>
Project-URL: Homepage, https://github.com/mdennis281/py-lanscape
Project-URL: Issues, https://github.com/mdennis281/py-lanscape/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: <=3.13,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Flask<5.0,>=3.0
Requires-Dist: psutil<7.0,>=6.0
Requires-Dist: requests<3.0,>=2.32
Requires-Dist: setuptools
Requires-Dist: pywebview<6.0,>=4.2
Requires-Dist: scapy<3.0,>=2.3.2
Requires-Dist: tabulate==0.9.0
Requires-Dist: pytest

# LANscape
A python based local network scanner.

![screenshot](https://github.com/mdennis281/py-lanscape/raw/main/src/lanscape/ui/static/img/readme1.png)

## Local Run
```sh
pip install lanscape
python -m lanscape
```

## Flags
 - `--port <port number>` port of the flask app (default: 5001)
 - `--nogui` run in web mode (default: false)
 - `--reloader` essentially flask debug mode- good for local development (default: false)
 - `--logfile` save log output to lanscape.log
 - `--loglevel <level>` set the logger's log level (default: INFO)
 - `--headless` similar to nogui but doesnt try to open a browser (default: false)
 

Examples:
```shell
python -m lanscape --reloader
python -m lanscape --nogui --port 5002
python -m lanscape --logfile --loglevel DEBUG
```

## Troubleshooting

### MAC Address / Manufacturer is inaccurate/unknown
The program does an ARP lookup to determine the MAC address. This lookup
can sometimes require admin-level permissions to retrieve accurate results.
*Try elevating your shell before execution.*

### Message "WARNING: No libpcap provider available ! pcap won't be used"
This is a missing dependency related to the ARP lookup. This is handled in the code, but you would get marginally faster/better results with this installed: [npcap download](https://npcap.com/#download)


### Unable to start webview client. Try --nogui (Linux)
Linux and QT (GUI package) dont seem to play well with each other very well. If you really want the gui (`python -m lanscape --nogui` is almost as good) I had success on ubuntu desktop by running these:
```sh
sudo apt install libcairo2-dev libxt-dev libgirepository1.0-dev
pip install pycairo PyGObject qtpy PyQt5 PyQtWebEngine
```


### Something else
Feel free to submit a github issue detailing your experience.


