A python simple and flexible CLI tool used to network testing.
Project description
Netbox
A python simple and flexible CLI tool used to network testing.
Introduction
This command line tool integrates some common network operations, such as wireless network connection, network ping, network speed measurement, etc., which can be done by using simple commands. The tool supports cross-platform, consistent command-line style for the three major operating systems and user-friendly. In addition, the tool provides a rich function interface which is convenient for users to integrate according to the actual business.
Getting Started
Prerequisites
-
Install python3 on your local machine, no matter what operating system you are using, you can refer to the link as below
-
Install git on your local machine, no matter what operating system you are using, you can refer to the link as below
Installing
A step by step series of examples that tell you how to get the CLI tool running.
Installing via git repository
-
Clone project with git command
git clone https://github.com/Hellboycc/netbox.git
-
Create a virtual environment in the project root directory
cd netbox python -m venv .venv
-
Activate current virtual environment
# For MacOS cd .venv/bin source activate
-
Install all dependency with pip3 command
# In this path /Users/..../netbox pip3 install -r requirements.txt
-
Install project on your local machine
# In this path /Users/..../netbox pip3 install -e .
Installing from pypi
If you don't want to use git repository, you could choose to download from pypi.org and install to use.
pip3 install netbox
Running CLI on your terminal window
-
Example for display CLI tool information
netbox-cli Usage: netbox-cli [OPTIONS] COMMAND [ARGS]... A simple and flexible CLI tool for network testing Options: --version Print version information and quit --help Show this message and exit. Commands: version Show the CLI tool version information wlan Manage wifi network
-
Example for child commands
netbox-cli wlan Usage: netbox-cli wlan [OPTIONS] COMMAND [ARGS]... Manage wifi network Options: --help Show this message and exit. Commands: connect Connect a wifi network current Current wifi network information disconnect Disconnect current wifi network scan Scan surround wifi network
-
Example for dispaly current version
netbox-cli version Current version is v0.0.1
-
Example for scan a specified wifi network exists or not
netbox-cli wlan scan --ssid Hellboycc Current ssid Hellboycc is not found.
Testing
The project contains complete unit tests, if you want to know the unit test results before using the tool, you can get the detailed test results by executing the unit tests.
How to run unit test
-
Install all dependency of develop
# For MacOS cd netbox python -m venv .venv cd .venv/bin source activate # In this path /Users/..../netbox pip3 install -r requirements-dev.txt
-
Running unit test with tox command
# In this path /Users/..../netbox tox
FAQ & Issues
-
If you encounter any problems in using it, please keep in touch with me and I will reply as soon as possible, you can access to the link as below
-
Other classic questions
License
This project is licensed under the MIT License (see the LICENSE file for details).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.