# README #
This idea was born because of a need for a simple tool to generate a network topology out of the information obtained from the output of `show router interface` command.
---
## Setup ##
### System Libraries
These libraries have been tested under Ubuntu 20.04 and Windows10 with Python3.8.
###### Ubuntu
```bash
pip3 install logToTopo
```
###### Windows
For Windows users, make sure you have Python and [PIP](https://pip.pypa.io/en/stable/installing/) installed.
```bash
py -m pip install logToTopo
```
---
## Usage ##
1) Getting data
To obatain the data, use [taskAutom](https://pypi.org/project/taskAutom/) where the plugin uses only the `show router inteface` command.
Example: `taskAutom -d data -py plugin -j 2`
2) Generate the topology. [logChecker](https://pypi.org/project/logChecker/) will be ran within `logToTop`. This will generate an Excel file with the parsed content. Use that as input.
Example: `logToTopo -xs sheet_name -folder folder_at_step_1`
Raw data
{
"_id": null,
"home_page": "https://github.com/laimaretto/logToTopo",
"name": "logToTopo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Lucas Aimaretto",
"author_email": "laimaretto@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/be/8b/2a63226a2d2c30369924412736fc52ce9d67d802fcf739bc5b2e5a05010c/logToTopo-1.1.1.tar.gz",
"platform": null,
"description": "# README #\n\nThis idea was born because of a need for a simple tool to generate a network topology out of the information obtained from the output of `show router interface` command.\n\n---\n## Setup ##\n\n### System Libraries\nThese libraries have been tested under Ubuntu 20.04 and Windows10 with Python3.8.\n\n###### Ubuntu\n```bash\npip3 install logToTopo\n```\n###### Windows\nFor Windows users, make sure you have Python and [PIP](https://pip.pypa.io/en/stable/installing/) installed.\n```bash\npy -m pip install logToTopo\n```\n---\n## Usage ##\n\n1) Getting data\nTo obatain the data, use [taskAutom](https://pypi.org/project/taskAutom/) where the plugin uses only the `show router inteface` command.\n\nExample: `taskAutom -d data -py plugin -j 2`\n\n2) Generate the topology. [logChecker](https://pypi.org/project/logChecker/) will be ran within `logToTop`. This will generate an Excel file with the parsed content. Use that as input.\n\nExample: `logToTopo -xs sheet_name -folder folder_at_step_1`\n\n",
"bugtrack_url": null,
"license": "BSD 3-clause",
"summary": "A simple topology generation tool",
"version": "1.1.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "8f1543d516350bdc61e0eba2d20e1bdc",
"sha256": "e78caa0ab05f85961635d7e5c5a77628ee8180b170d3b8391bb3d1162c02c154"
},
"downloads": -1,
"filename": "logToTopo-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f1543d516350bdc61e0eba2d20e1bdc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6402,
"upload_time": "2022-12-06T20:33:53",
"upload_time_iso_8601": "2022-12-06T20:33:53.974131Z",
"url": "https://files.pythonhosted.org/packages/c8/6a/4f1ce6eb8c2b7e694f1ddb45c329db297221694789cfcaaacc5e06c5e679/logToTopo-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "ee6dfb8b7dd5e0df85fcac652bff41d7",
"sha256": "38e7b4bc07aba44e25e5af93e3c077ad25f76c774a029a1c7c66b0ee228ad870"
},
"downloads": -1,
"filename": "logToTopo-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ee6dfb8b7dd5e0df85fcac652bff41d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5391,
"upload_time": "2022-12-06T20:33:55",
"upload_time_iso_8601": "2022-12-06T20:33:55.738247Z",
"url": "https://files.pythonhosted.org/packages/be/8b/2a63226a2d2c30369924412736fc52ce9d67d802fcf739bc5b2e5a05010c/logToTopo-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-06 20:33:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "laimaretto",
"github_project": "logToTopo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "logtotopo"
}