diff options
Diffstat (limited to 'python-netbox.spec')
| -rw-r--r-- | python-netbox.spec | 494 |
1 files changed, 494 insertions, 0 deletions
diff --git a/python-netbox.spec b/python-netbox.spec new file mode 100644 index 0000000..19f22d4 --- /dev/null +++ b/python-netbox.spec @@ -0,0 +1,494 @@ +%global _empty_manifest_terminate_build 0 +Name: python-netbox +Version: 0.0.2 +Release: 1 +Summary: A python simple and flexible CLI tool used to network testing. +License: MIT License +URL: https://github.com/Hellboycc/netbox +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/3a/c7/2daf95337a2ce5c1b4eb45c252a6f350d9fa8b2ead0c759ec84103f8c115/netbox-0.0.2.tar.gz +BuildArch: noarch + +Requires: python3-click +Requires: python3-ping3 + +%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 + + [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). + + + +%package -n python3-netbox +Summary: A python simple and flexible CLI tool used to network testing. +Provides: python-netbox +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-netbox +# 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). + + + +%package help +Summary: Development documents and examples for netbox +Provides: python3-netbox-doc +%description help +# 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). + + + +%prep +%autosetup -n netbox-0.0.2 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-netbox -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 17 2023 Python_Bot <Python_Bot@openeuler.org> - 0.0.2-1 +- Package Spec generated |