Metadata-Version: 2.1
Name: vtrace
Version: 1.0.0
Summary: A command line application to trace the route to a host and provide the user with a visual map.
Home-page: https://github.com/RichardBieringa/vtrace
License: MIT
Keywords: vtrace,traceroute,visual
Author: Richard Bieringa
Author-email: richardbieringa@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: click (>=8.0.3,<9.0.0)
Requires-Dist: folium (>=0.12.1,<0.13.0)
Requires-Dist: ipinfo (>=4.2.1,<5.0.0)
Requires-Dist: scapy (>=2.4.5,<3.0.0)
Project-URL: Repository, https://github.com/RichardBieringa/vtrace
Description-Content-Type: text/markdown

# VTrace - Visualize traceroutes 🚀

[![codecov](https://codecov.io/gh/RichardBieringa/vtrace/branch/master/graph/badge.svg?token=RB6Y7SZ1FC)](https://codecov.io/gh/RichardBieringa/vtrace)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## Description
Mimicks a primitive version of [GNU traceroute](https://linux.die.net/man/8/traceroute) while providing a visual map of the route in the browser! 

![Example Traceroute](example/terminal.png)
![Example Map](example/map.png)

## Installation

Install using pip
```sh
$ pip install vtrace
```

## Usage

⚠️ **Warning:** requires elevated priviledges ⚠️

```sh
# vtrace google.com
```

For help run 
```sh
$ vtrace --help
```

## Tools used

| Plugin | README |
| ------ | ------ |
| [Scapy](https://scapy.net/) | For creating/sending network packets to implement traceroute functionalities.  |
| [IPInfo](https://ipinfo.io/) | Geolocation service to get the coordinates of IP addresses.  |
| [Folium](https://python-visualization.github.io/folium/) | To implement the visual mapping. |
| [Click](https://click.palletsprojects.com/en/8.0.x/) | To create the command line interface. |


