First create your virtual environment

python3 -m venv ~/virtualenv/home_nmap
. ~/virtualenv/home_nmap/bin/activate
python -m pip install --upgrade pip

Then clone the code from GitHub:

git clone

After that compile your wheel and install it

python bdist_wheel
pip install home_nmap-0.0.1-py3-none-any.whl

Or deploy it in 'developer' mode

python develop

Generating network diagrams

Some diagrams for this article where generated with 'diagrams'. You can install just diagram and then run the scripts:

If you install the project as explained above you should be able to run the '' script.

Running the webservice

Assuming that you installed the application in your virtual environment:

. ~/virtualenv/home_nmap/bin/activate
uvicorn home_nmap:main:app --reload

Then use a browser and go to localhost