automatic import of python-vilfo-api-clientopeneuler20.03

3 files changed, 351 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index e69de29..442e2bb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/vilfo-api-client-0.4.1.tar.gz
diff --git a/python-vilfo-api-client.spec b/python-vilfo-api-client.spec
new file mode 100644
index 0000000..f951bf1
--- /dev/null
+++ b/python-vilfo-api-client.spec
@@ -0,0 +1,349 @@
+%global _empty_manifest_terminate_build 0
+Name:		python-vilfo-api-client
+Version:	0.4.1
+Release:	1
+Summary:	Simple wrapper client for the Vilfo router API
+License:	MIT License
+URL:		https://github.com/mannew/vilfo-api-client-python
+Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/4c/54/b92a0f02abf6d375edc7b70b0ec15ad1a4ee76bbf5c0f45ac451c528cfa9/vilfo-api-client-0.4.1.tar.gz
+BuildArch:	noarch
+
+Requires:	python3-requests
+Requires:	python3-getmac
+Requires:	python3-responses
+Requires:	python3-responses
+
+%description
+# vilfo-api-client-python
+
+This is the initial version of a python module and API client for the Vilfo router. The module is targeted towards compatibility with Python3.
+
+Currently, the client is quite limited but will be extended with support for additional endpoints over time.
+
+See `vilfo/client.py` for additional information about available methods. A short usage example is available in this README as well.
+
+## Legal Disclaimer
+
+Please note that this software is not affiliated with Vilfo AB, is not an official client for the Vilfo router API and the developers take no legal responsibility for the functionality or security of your Vilfo router. Support is only offered on a community basis.
+
+## Information about the Vilfo router and API
+
+You can find more information about the Vilfo router on [www.vilfo.com](https://www.vilfo.com/).
+
+From there you can also find information about the API in the form of the official API documentation: https://www.vilfo.com/apidocs/
+
+## Installation
+
+The preferred installation method is by using `pip`:
+
+`pip install vilfo-api-client`
+
+## Usage
+
+The API client is available through the class `vilfo.Client`. To establish a connection and make the API calls, you will need the **hostname or IP of your router** (`admin.vilfo.com` is the default one) as well as an **API access token**.
+
+### Obtaining an access token
+
+Information about how to get an access token is described in the official API documentation: https://www.vilfo.com/apidocs/#header-authorization
+
+**Note:** In version 1.0.13 of the Vilfo firmware, access tokens are invalidated when a new login to the web UI is made. To prevent web UI logins from interfering with the API calls, you can create a separate user solely for API purposes and use its access token.
+
+### Creating the client and making calls
+
+This is a basic sample of how you can use the `vilfo-api-client`.
+
+```python
+import vilfo
+
+client = vilfo.Client(
+    host='admin.vilfo.com',
+    token='YOUR_ACCESS_TOKEN'
+)
+
+# Ping to check if router is online
+result = client.ping()
+print(result)
+
+try:
+    # Get the last reported load
+    result = client.get_load()
+    print(result)
+
+    # Get a list of all devices
+    result = client.get_devices()
+    print(result)
+
+    # Get a boolean indicating if a device is online or not
+    result = client.is_device_online(
+        mac_address='08:00:27:8e:ac:31'
+    )
+    print(result)
+
+    # Get detailed information about a specific device
+    result = client.get_device(
+        mac_address='08:00:27:8e:ac:31'
+    )
+    print(result)
+
+except vilfo.exceptions.AuthenticationException:
+    print("Authentication Exception")
+```
+
+### Exceptions and error handling
+
+The `vilfo-api-client` library defines a set of exceptions that can be used to handle errors. These exception classes are located under `vilfo.exceptions`.
+
+*Additional information about the exceptions will be added and exception and error handling will be improved further.*
+
+## Changelog
+
+### Version 0.3.1
+
+Minor adjustment in Client constructor to allow for better mocking during testing.
+
+### Version 0.3
+
+Initial stable release.
+
+
+
+%package -n python3-vilfo-api-client
+Summary:	Simple wrapper client for the Vilfo router API
+Provides:	python-vilfo-api-client
+BuildRequires:	python3-devel
+BuildRequires:	python3-setuptools
+BuildRequires:	python3-pip
+%description -n python3-vilfo-api-client
+# vilfo-api-client-python
+
+This is the initial version of a python module and API client for the Vilfo router. The module is targeted towards compatibility with Python3.
+
+Currently, the client is quite limited but will be extended with support for additional endpoints over time.
+
+See `vilfo/client.py` for additional information about available methods. A short usage example is available in this README as well.
+
+## Legal Disclaimer
+
+Please note that this software is not affiliated with Vilfo AB, is not an official client for the Vilfo router API and the developers take no legal responsibility for the functionality or security of your Vilfo router. Support is only offered on a community basis.
+
+## Information about the Vilfo router and API
+
+You can find more information about the Vilfo router on [www.vilfo.com](https://www.vilfo.com/).
+
+From there you can also find information about the API in the form of the official API documentation: https://www.vilfo.com/apidocs/
+
+## Installation
+
+The preferred installation method is by using `pip`:
+
+`pip install vilfo-api-client`
+
+## Usage
+
+The API client is available through the class `vilfo.Client`. To establish a connection and make the API calls, you will need the **hostname or IP of your router** (`admin.vilfo.com` is the default one) as well as an **API access token**.
+
+### Obtaining an access token
+
+Information about how to get an access token is described in the official API documentation: https://www.vilfo.com/apidocs/#header-authorization
+
+**Note:** In version 1.0.13 of the Vilfo firmware, access tokens are invalidated when a new login to the web UI is made. To prevent web UI logins from interfering with the API calls, you can create a separate user solely for API purposes and use its access token.
+
+### Creating the client and making calls
+
+This is a basic sample of how you can use the `vilfo-api-client`.
+
+```python
+import vilfo
+
+client = vilfo.Client(
+    host='admin.vilfo.com',
+    token='YOUR_ACCESS_TOKEN'
+)
+
+# Ping to check if router is online
+result = client.ping()
+print(result)
+
+try:
+    # Get the last reported load
+    result = client.get_load()
+    print(result)
+
+    # Get a list of all devices
+    result = client.get_devices()
+    print(result)
+
+    # Get a boolean indicating if a device is online or not
+    result = client.is_device_online(
+        mac_address='08:00:27:8e:ac:31'
+    )
+    print(result)
+
+    # Get detailed information about a specific device
+    result = client.get_device(
+        mac_address='08:00:27:8e:ac:31'
+    )
+    print(result)
+
+except vilfo.exceptions.AuthenticationException:
+    print("Authentication Exception")
+```
+
+### Exceptions and error handling
+
+The `vilfo-api-client` library defines a set of exceptions that can be used to handle errors. These exception classes are located under `vilfo.exceptions`.
+
+*Additional information about the exceptions will be added and exception and error handling will be improved further.*
+
+## Changelog
+
+### Version 0.3.1
+
+Minor adjustment in Client constructor to allow for better mocking during testing.
+
+### Version 0.3
+
+Initial stable release.
+
+
+
+%package help
+Summary:	Development documents and examples for vilfo-api-client
+Provides:	python3-vilfo-api-client-doc
+%description help
+# vilfo-api-client-python
+
+This is the initial version of a python module and API client for the Vilfo router. The module is targeted towards compatibility with Python3.
+
+Currently, the client is quite limited but will be extended with support for additional endpoints over time.
+
+See `vilfo/client.py` for additional information about available methods. A short usage example is available in this README as well.
+
+## Legal Disclaimer
+
+Please note that this software is not affiliated with Vilfo AB, is not an official client for the Vilfo router API and the developers take no legal responsibility for the functionality or security of your Vilfo router. Support is only offered on a community basis.
+
+## Information about the Vilfo router and API
+
+You can find more information about the Vilfo router on [www.vilfo.com](https://www.vilfo.com/).
+
+From there you can also find information about the API in the form of the official API documentation: https://www.vilfo.com/apidocs/
+
+## Installation
+
+The preferred installation method is by using `pip`:
+
+`pip install vilfo-api-client`
+
+## Usage
+
+The API client is available through the class `vilfo.Client`. To establish a connection and make the API calls, you will need the **hostname or IP of your router** (`admin.vilfo.com` is the default one) as well as an **API access token**.
+
+### Obtaining an access token
+
+Information about how to get an access token is described in the official API documentation: https://www.vilfo.com/apidocs/#header-authorization
+
+**Note:** In version 1.0.13 of the Vilfo firmware, access tokens are invalidated when a new login to the web UI is made. To prevent web UI logins from interfering with the API calls, you can create a separate user solely for API purposes and use its access token.
+
+### Creating the client and making calls
+
+This is a basic sample of how you can use the `vilfo-api-client`.
+
+```python
+import vilfo
+
+client = vilfo.Client(
+    host='admin.vilfo.com',
+    token='YOUR_ACCESS_TOKEN'
+)
+
+# Ping to check if router is online
+result = client.ping()
+print(result)
+
+try:
+    # Get the last reported load
+    result = client.get_load()
+    print(result)
+
+    # Get a list of all devices
+    result = client.get_devices()
+    print(result)
+
+    # Get a boolean indicating if a device is online or not
+    result = client.is_device_online(
+        mac_address='08:00:27:8e:ac:31'
+    )
+    print(result)
+
+    # Get detailed information about a specific device
+    result = client.get_device(
+        mac_address='08:00:27:8e:ac:31'
+    )
+    print(result)
+
+except vilfo.exceptions.AuthenticationException:
+    print("Authentication Exception")
+```
+
+### Exceptions and error handling
+
+The `vilfo-api-client` library defines a set of exceptions that can be used to handle errors. These exception classes are located under `vilfo.exceptions`.
+
+*Additional information about the exceptions will be added and exception and error handling will be improved further.*
+
+## Changelog
+
+### Version 0.3.1
+
+Minor adjustment in Client constructor to allow for better mocking during testing.
+
+### Version 0.3
+
+Initial stable release.
+
+
+
+%prep
+%autosetup -n vilfo-api-client-0.4.1
+
+%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-vilfo-api-client -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.1-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..a4d16c3
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+394dba3cb2f83e562a90040aa39566e0  vilfo-api-client-0.4.1.tar.gz