https://github.com/cisco-open/network-sketcher
Network Skecher makes network design and configuration management faster, more accurate, and easier. Simply create your first rough sketch and it will automatically generate L1L2L3 network diagrams and management tables.
https://github.com/cisco-open/network-sketcher
Last synced: about 2 months ago
JSON representation
Network Skecher makes network design and configuration management faster, more accurate, and easier. Simply create your first rough sketch and it will automatically generate L1L2L3 network diagrams and management tables.
- Host: GitHub
- URL: https://github.com/cisco-open/network-sketcher
- Owner: cisco-open
- License: apache-2.0
- Created: 2023-08-08T08:29:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-22T05:52:38.000Z (about 1 year ago)
- Last Synced: 2024-04-22T06:43:45.320Z (about 1 year ago)
- Language: Python
- Homepage: https://github.com/cisco-open/network-sketcher
- Size: 17.5 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Network Sketcher
**Network Sketcher generates network configuration diagrams in PowerPoint and manages configuration information in Excel.**
* Automatic generation of each configuration document by metadatization of network configuration information
* Automated synchronization between documents
* Minimize maintenance and training load by automatic generation of common formats
* Facilitate automatic analysis, AI utilization, and inter-system collaboration by metadatization of configuration information.
* Template support for equipment configuration
# DEMO
https://github.com/cisco-open/network-sketcher/assets/13013736/b76ec8fa-44ad-4d02-a7c2-579f67ad24a9
# New Features
- Ver 2.4.1
- [Optimized placement of segments in the Layer 3 overall configuration chart](https://github.com/cisco-open/network-sketcher/releases/tag/Ver2.4.1)
- Ver 2.4.0
- [Attributes can be added to device files to reflect colors on diagrams ](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/4-8.%20Attribute_settings.md)
- Ver 2.3.4
- [Summary Diagram is automatically added in L1 All Areas](https://github.com/cisco-open/network-sketcher/releases/tag/Ver2.3.4)
- Ver 2.3.3
- [Two patterns are created: area-oriented and connection-oriented](https://github.com/cisco-open/network-sketcher/releases/tag/Ver2.3.3)
- Ver 2.3.2
- ["VPNs on L3” has been added to the VPN configuration diagram to reflect VPN segments in the Layer 3 logical configuration diagram.](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/6-2.%20VPN%20setting.md)
- Ver 2.3.1
- [Added the ability to output information in the master file via CLI](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/8-1.%20show%20commands.md)
- Ver 2.3.0
- [Added the ability to create an overall L3 diagram (All Areas)](https://github.com/cisco-open/network-sketcher/releases/tag/Ver2.3.0)
- Ver 2.2.2
- [Automated device placement adjustment in L1 diagram](https://github.com/user-attachments/assets/8014132b-4e38-422a-9ab0-3ee397e27b1e)
- Ver 2.2.1
- [IP address table](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/7-3.%20Export%20IP%20address%20table.md) :[(Sample output file) ](https://github.com/user-attachments/files/15784654/IP_TABLE.Sample.figure5.xlsx)
- Ver 2.2.0
- [Automatic IP address assignment](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/7-2.%20Automatic%20IP%20address%20assignment.md)
- Ver 2.1.0
- [VPN Diagram](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/6-1.%20Generation%20of%20VPN%20Diagram%20.md)
- [VPN Configuration](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/6-2.%20VPN%20setting.md)
- [Cross-platform support (Windows, Linux, Mac OS)](https://github.com/user-attachments/assets/04ab332d-c876-44ff-83ef-b98d64d24b1f)
- [Drawing beyond maximum PowerPoint size](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/A-1.%20Procedure%20for%20pasting%20PPT%20figures%20that%20exceed%20the%20maximum%20paper%20size%20into%20Excel.md)
- [Import of yaml file from CML(Cisco Modeling Labs) diagrams](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/7-1.%20Convert%20CML%20configuration%20file%20(yaml)%20to%20Network%20Sketcher%20master%20file.md)
# Limitations
- IPv4 only. IPv6 is not supported.
# Requirement
- __Network Sketcher supports cross-platform. Works with Windows, Mac OS, and Linux.__
- __Python ver 3.x__
- __Software that can edit .pptx and .xlsx files__
- Microsoft Powerpoint and Excel are the best
- Google Slides and Spreadsheets import/export functionality is available. Excel functions display will show an error, but it works fine.
- Libre Office and Softmaker office cannot be used.
# Installation
```bash
git clone https://github.com/cisco-open/network-sketcher/
cd network-sketcher
python -m pip install -r requirements.txt
python network_sketcher.py
```
or
```bash
#Download via browser
https://github.com/cisco-open/network-sketcher/archive/refs/heads/main.zip
#Unzip the ZIP file and execute the following in the prompt of the folder
python -m pip install -r requirements.txt
python network_sketcher.py
```
# Installation Supplement
* Alternative to “python -m pip install -r requirements.txt”
```bash
python -m pip install tkinterdnd2-universal
python -m pip install tkinterdnd2
python -m pip install "openpyxl>=3.1.3,<=3.1.5"
python -m pip install python-pptx
python -m pip install ipaddress
python -m pip install numpy
python -m pip install pyyaml
python -m pip install ciscoconfparse
```
* Mac OS requires the following additional installation.
```bash
brew install tcl-tk
```
* Linux requires the following additional installation.
```bash
sudo apt-get install python3-tk
```
# User Guide
| Language | Link |
| ------------- | ------------- |
| English | [Link](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/English/User_Guide%5BEN%5D.md) |
| Japanese | [Link](https://github.com/cisco-open/network-sketcher/blob/main/User_Guide/Japanese/User_Guide%5BJP%5D.md) |
# How to create the exe file for Windows using pyinstaller
```bash
pyinstaller.exe [file path]/network_sketcher.py --onefile --collect-data tkinterdnd2 --noconsole --additional-hooks-dir [file path] --clean
```
# SAMPLE
## Input ppt file (rough sketch)
[Sample-rough5.pptx](https://github.com/user-attachments/files/18668273/Sample-rough5.pptx)
## Output
### L1 figure(PPT)
[[L1_DIAGRAM]AllAreasTag_Sample.figure5.pptx](https://github.com/user-attachments/files/18611145/L1_DIAGRAM.AllAreasTag_Sample.figure5.pptx)
### L2 figure(PPT)
[[L2_DIAGRAM]DC-TOP1_Sample.figure5.pptx](https://github.com/user-attachments/files/18611147/L2_DIAGRAM.DC-TOP1_Sample.figure5.pptx)
### L3 figure(PPT)
[[L3_DIAGRAM]AllAreas_old_Sample.figure5.pptx](https://github.com/user-attachments/files/18611149/L3_DIAGRAM.AllAreas_old_Sample.figure5.pptx)
### Device table(Excel)
[[DEVICE]Sample.figure5.xlsx](https://github.com/user-attachments/files/18611140/DEVICE.Sample.figure5.xlsx)
### Master file(Excel)
[[MASTER]Sample.figure5.xlsx](https://github.com/user-attachments/files/18918397/MASTER_Sample.figure5.zip)
# Author
* Yusuke Ogawa
* CCIE# 17583
* Security Architect @ Cisco
# License
SPDX-License-Identifier: Apache-2.0
Copyright 2023 Cisco Systems, Inc. and its affiliates
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.