# route-graph
CLI tool for creating graphs of routes.
This tool simply wraps the example of [TCP traceroute](https://scapy.readthedocs.io/en/latest/usage.html#tcp-traceroute-2)
which is mentioned in the `scapy` documentation.
## Requirements
You will need `graphviz` to be installed. If `graphviz` is not available
on your system the graph can be created.
`route-graph` has to be executed with `sudo`.
## Installation
The package is available in the [Python Package Index](https://pypi.org/project/route-graph/).
```bash
$ pip3 install route-graph --user
```
To get the lastest state:
```bash
$ pip install git+https://github.com/audiusGmbH/route-graph.git
```
For Nix or NixOS users is a [package](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=route-graph)
available in Nixpkgs. Keep in mind that the lastest releases might only
be present in the ``unstable`` channel.
```bash
$ nix-env -iA nixos.route-graph
```
## Usage
```bash
$ sudo ./route-graph --help
Usage: route-graph [OPTIONS] COMMAND [ARGS]...
Tool to draw a graph of traceroute results.
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ graph Create a graph from traceroute results. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```
The graph could then be found in the current directory. The format is `png`.
## License
`route-graph` is licensed under MIT, for more details check the LICENSE file.
Raw data
{
"_id": null,
"home_page": "https://github.com/audiusGmbH/route-graph",
"name": "route-graph",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "traceroute, graph, routes",
"author": "Fabian Affolter",
"author_email": "mail@fabian-affolter.ch",
"download_url": "https://files.pythonhosted.org/packages/05/fd/970fb9f49d4d1d5e4cd9089d55734a8416085a194270eae257a3cafc61d6/route_graph-0.2.2.tar.gz",
"platform": null,
"description": "# route-graph\n\nCLI tool for creating graphs of routes.\n\nThis tool simply wraps the example of [TCP traceroute](https://scapy.readthedocs.io/en/latest/usage.html#tcp-traceroute-2)\nwhich is mentioned in the `scapy` documentation.\n\n## Requirements\n\nYou will need `graphviz` to be installed. If `graphviz` is not available\non your system the graph can be created.\n\n`route-graph` has to be executed with `sudo`.\n\n## Installation\n\nThe package is available in the [Python Package Index](https://pypi.org/project/route-graph/).\n\n```bash\n$ pip3 install route-graph --user\n```\n\nTo get the lastest state:\n\n```bash\n$ pip install git+https://github.com/audiusGmbH/route-graph.git\n```\n\nFor Nix or NixOS users is a [package](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=route-graph)\navailable in Nixpkgs. Keep in mind that the lastest releases might only\nbe present in the ``unstable`` channel.\n\n```bash\n$ nix-env -iA nixos.route-graph\n```\n\n## Usage\n\n```bash\n$ sudo ./route-graph --help\n \n Usage: route-graph [OPTIONS] COMMAND [ARGS]... \n \n Tool to draw a graph of traceroute results. \n \n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --install-completion Install completion for the current shell. \u2502\n\u2502 --show-completion Show completion for the current shell, to copy it or customize the installation. \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 graph Create a graph from traceroute results. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\nThe graph could then be found in the current directory. The format is `png`.\n\n## License\n\n`route-graph` is licensed under MIT, for more details check the LICENSE file.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tool for creating graphs of routes",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/audiusGmbH/route-graph",
"Repository": "https://github.com/audiusGmbH/route-graph"
},
"split_keywords": [
"traceroute",
" graph",
" routes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36b2f1cead30aa6cb0cbb69509cea8b110c4a0e4b64d3bbd34efbffa7fcdb80d",
"md5": "ca74d720056c9c7e27129beb0edbc870",
"sha256": "d0ac7782db22a5877d334f93b380cf8acf99c584dfc970180b1626c9d2fe2e9a"
},
"downloads": -1,
"filename": "route_graph-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca74d720056c9c7e27129beb0edbc870",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 4288,
"upload_time": "2024-04-29T06:54:06",
"upload_time_iso_8601": "2024-04-29T06:54:06.406256Z",
"url": "https://files.pythonhosted.org/packages/36/b2/f1cead30aa6cb0cbb69509cea8b110c4a0e4b64d3bbd34efbffa7fcdb80d/route_graph-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05fd970fb9f49d4d1d5e4cd9089d55734a8416085a194270eae257a3cafc61d6",
"md5": "818f6424fb87cffeb43a76bb6913d9ef",
"sha256": "f5d213faad7fa973f62f66b1a08dc90dd1c375ba31eb49eab136ca83c1a57094"
},
"downloads": -1,
"filename": "route_graph-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "818f6424fb87cffeb43a76bb6913d9ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 3289,
"upload_time": "2024-04-29T06:54:07",
"upload_time_iso_8601": "2024-04-29T06:54:07.471866Z",
"url": "https://files.pythonhosted.org/packages/05/fd/970fb9f49d4d1d5e4cd9089d55734a8416085a194270eae257a3cafc61d6/route_graph-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 06:54:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "audiusGmbH",
"github_project": "route-graph",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "route-graph"
}
JSON
