# 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
[How to install python3](https://realpython.com/installing-python/)
* Install git on your local machine, no matter what operating system you are using, you can refer to the link as below
[How to install git](https://git-scm.com/)
## Installing
A step by step series of examples that tell you how to get the CLI tool running.
### Installing via git repository
1. Clone project with git command
```shell
git clone https://github.com/Hellboycc/netbox.git
```
2. Create a virtual environment in the project root directory
```shell
cd netbox
python -m venv .venv
```
3. Activate current virtual environment
```shell
# For MacOS
cd .venv/bin
source activate
```
4. Install all dependency with pip3 command
```shell
# In this path /Users/..../netbox
pip3 install -r requirements.txt
```
5. Install project on your local machine
```shell
# 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](https://pypi.org/project/netbox/0.0.1/) and install to use.
```shell
pip3 install netbox
```
### Running CLI on your terminal window
1. Example for display CLI tool information
```shell
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
```
2. Example for child commands
```shell
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
```
3. Example for dispaly current version
```shell
netbox-cli version
Current version is v0.0.1
```
4. Example for scan a specified wifi network exists or not
```shell
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
1. Install all dependency of develop
```shell
# For MacOS
cd netbox
python -m venv .venv
cd .venv/bin
source activate
# In this path /Users/..../netbox
pip3 install -r requirements-dev.txt
```
2. Running unit test with tox command
```shell
# 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
[Issues of project](https://github.com/Hellboycc/netbox/issues)
- Other classic questions
[FAQ](#)
# License
This project is licensed under the MIT License (see the [LICENSE](https://choosealicense.com/licenses/mit/) file for details).
Raw data
{
"_id": null,
"home_page": "https://github.com/Hellboycc/netbox",
"name": "netbox",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "CLI tool,Network,Software Testing",
"author": "Hellboycc",
"author_email": "luoyingchuan1210@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3a/c7/2daf95337a2ce5c1b4eb45c252a6f350d9fa8b2ead0c759ec84103f8c115/netbox-0.0.2.tar.gz",
"platform": null,
"description": "# Netbox\nA python simple and flexible CLI tool used to network testing.\n\n# Introduction\nThis 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.\n\n# Getting Started\n## Prerequisites\n* Install python3 on your local machine, no matter what operating system you are using, you can refer to the link as below\n\n\t[How to install python3](https://realpython.com/installing-python/)\n* Install git on your local machine, no matter what operating system you are using, you can refer to the link as below\n\n\t[How to install git](https://git-scm.com/)\n\t\n## Installing\nA step by step series of examples that tell you how to get the CLI tool running.\n\n### Installing via git repository\n1. Clone project with git command\n\n\t```shell\n\tgit clone https://github.com/Hellboycc/netbox.git\n\t\n\t```\n2. Create a virtual environment in the project root directory\n\n\t```shell\n\tcd netbox\n\tpython -m venv .venv\n\t```\n3. Activate current virtual environment\n\n\t```shell\n\t# For MacOS\n\tcd .venv/bin\n\tsource activate\n\t```\n4. Install all dependency with pip3 command\n\n\t```shell\n\t# In this path /Users/..../netbox\n\tpip3 install -r requirements.txt\n\t```\n5. Install project on your local machine\n\n\t```shell\n\t# In this path /Users/..../netbox \n\tpip3 install -e .\n\t```\n\t\n### Installing from pypi\nIf you don't want to use git repository, you could choose to download from [pypi.org](https://pypi.org/project/netbox/0.0.1/) and install to use.\n\n```shell\npip3 install netbox\n```\n\t\n### Running CLI on your terminal window\n1. Example for display CLI tool information\n\t\n\t```shell\n\tnetbox-cli \n\tUsage: netbox-cli [OPTIONS] COMMAND [ARGS]...\n\t\n\t A simple and flexible CLI tool for network testing\n\t\n\tOptions:\n\t --version Print version information and quit\n\t --help Show this message and exit.\n\t\n\tCommands:\n\t version Show the CLI tool version information\n\t wlan Manage wifi network\n\t```\n2. Example for child commands\n\t\n\t```shell\n\tnetbox-cli wlan \n\tUsage: netbox-cli wlan [OPTIONS] COMMAND [ARGS]...\n\t\n\t Manage wifi network\n\t\n\tOptions:\n\t --help Show this message and exit.\n\t\n\tCommands:\n\t connect Connect a wifi network\n\t current Current wifi network information\n\t disconnect Disconnect current wifi network\n\t scan Scan surround wifi network\n\t```\n3. Example for dispaly current version\n\n\t```shell\n\tnetbox-cli version \n\t \n\tCurrent version is v0.0.1\n\t```\n4. Example for scan a specified wifi network exists or not\n\n\t```shell\n\tnetbox-cli wlan scan --ssid Hellboycc \n\t \n\tCurrent ssid Hellboycc is not found.\n\t```\n\t\n# Testing\nThe 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.\n### How to run unit test\n1. Install all dependency of develop\n\n\t```shell\n\t# For MacOS\n\tcd netbox\n\tpython -m venv .venv\n\tcd .venv/bin\n\tsource activate\n\t# In this path /Users/..../netbox\n\tpip3 install -r requirements-dev.txt\n\t```\n2. Running unit test with tox command\n\n\t```shell\n\t# In this path /Users/..../netbox\n\ttox\n\t```\n\n# FAQ & Issues\n- 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\n\n\t[Issues of project](https://github.com/Hellboycc/netbox/issues)\n\n- Other classic questions\n\n\t[FAQ](#)\n\n# License\nThis project is licensed under the MIT License (see the [LICENSE](https://choosealicense.com/licenses/mit/) file for details).\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A python simple and flexible CLI tool used to network testing.",
"version": "0.0.2",
"split_keywords": [
"cli tool",
"network",
"software testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "04c37844916b771ac3735395908e9460",
"sha256": "28baf9dad19ab0e29de96e164c91a79c036364f7d32acdc3ec520580c2aa8aea"
},
"downloads": -1,
"filename": "netbox-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "04c37844916b771ac3735395908e9460",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10614,
"upload_time": "2022-12-08T06:28:18",
"upload_time_iso_8601": "2022-12-08T06:28:18.872677Z",
"url": "https://files.pythonhosted.org/packages/26/b4/7cb6949faf1526593f07c6be76d6c3a7c3cd02e96d077267a87e7470c477/netbox-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "c361e9a3273ecb13a4d9f4d5fbb31384",
"sha256": "947e064cd4bbf7864bbd573b4244d5e148de02b94822222919b21bddd7217d09"
},
"downloads": -1,
"filename": "netbox-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "c361e9a3273ecb13a4d9f4d5fbb31384",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9886,
"upload_time": "2022-12-08T06:28:21",
"upload_time_iso_8601": "2022-12-08T06:28:21.644583Z",
"url": "https://files.pythonhosted.org/packages/3a/c7/2daf95337a2ce5c1b4eb45c252a6f350d9fa8b2ead0c759ec84103f8c115/netbox-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-08 06:28:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Hellboycc",
"github_project": "netbox",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "netbox"
}
JSON
