Merge pull request #1 from Virtomize/ftaubert/pylint

Create pylint.yml

Author: FrankT1983

.github/workflows/pylint.yml

@@ -0,0 +1,23 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

BUILD.md

@@ -1,7 +1,7 @@
 ## Build
 To build this package:
 1) run `python setup.py sdist bdist_wheel`
-2) get a pypi token from our [PyPi](pypi.org) account
+2) get a pypi token from our [PyPi](http://pypi.org) account
 3) Add the token to `$HOME/.pypirc` under `[pypi]` (follow instructions from the pypi webpage)
 4) run `python -m twine upload --repository pypi dist/*`
-   (run `python -m twine upload --repository testpypi dist/*` to publish a tests to [Test.PyPi](test.pypi.org))
+   (run `python -m twine upload --repository testpypi dist/*` to publish a tests to [Test.PyPi](http://test.pypi.org))

CONTRIBUTING.md

@@ -100,15 +100,15 @@ $ git push origin example-branch
 ### 7. Open the Pull Request
 
 From within GitHub, by opening a new Pull Request will present you with a template that should be filled out.
-Please fill out all details, feel free to skip not nessesary parts or if you're not sure what to fill in.
+Please fill out all details, feel free to skip not necessary parts or if you're not sure what to fill in.
 
-Once opened, the Pull Request is opend and will be reviewed.
+Once opened, the Pull Request is opened and will be reviewed.
 
 ### 8. Updates and discussion
 
 While reviewing you will probably get some feedback or requests for changes to your Pull Request. This is normal and a necessary part of the process to evaluate the changes and there correctness. 
 
-To make changes to an existsing Pull Request, make the changes to your local branch.
+To make changes to an existing Pull Request, make the changes to your local branch.
 Add a new commit including those changes and push them to your fork.
 The Pull Requests will be automatically updated by GitHub.
 

example.py

@@ -1,29 +1,34 @@
-#import src.uiipythonapi as uii
+""" Example for the usage of the UII python API package """
 import uiipythonapi as uii
 
 api = uii.Client("token here")
 packageList, err = api.read_package_list("debian", "10", "x86_64")
 print("Number of known packages for Debian 10: " + str(len(packageList)))
 
-def dhcp_network(domain: str = "", ipnet: str = "", gateway: str = "", dns: str = "", nointernet: bool = False):
+
+def dhcp_network():
+    """ Example of how to define a dynamic network """
     return {
         "dhcp": True,
-        # "domain": domain,
-        # "ipnet": ipnet,
-        # "gateway": gateway,
-        # "dns": dns,
         "nointernet": False,
     }
 
-def static_network(domain: str = "", ipnet: str = "", gateway: str = "", dns: str = "", nointernet: bool = False):
+
+def static_network(domain: str = "",
+                   ip_net: str = "",
+                   gateway: str = "",
+                   dns: str = "",
+                   no_internet: bool = False):
+    """ Example of how to define a static network """
     return {
         "dhcp": False,
         "domain": domain,
-        "ipnet": ipnet,
+        "ipnet": ip_net,
         "gateway": gateway,
         "dns": dns,
-        "nointernet": nointernet,
+        "nointernet": no_internet,
     }
 
-err = api.build("debian10.iso", "debian", "10", "x86_64", "horst", [dhcp_network()])
-print("Errors: " + str(err))
+
+ERROR = api.build("debian10.iso", "debian", "10", "x86_64", "horst", [dhcp_network()])
+print("Errors: " + str(ERROR))

requirements.txt

@@ -0,0 +1,2 @@
+requests
+pylint

setup.py

@@ -1,4 +1,6 @@
-import os
+"""
+Configuration for building the pip package
+"""
 
 from setuptools import setup
 
@@ -11,12 +13,12 @@
     url='https://github.com/virtomize/uii-python-api',
     author='Virtomize GmbH',
     author_email='api@virtomize.com',
-    description="A client implemenation for Virtomize Unattended Install Images API",
+    description="A client implementation for Virtomize Unattended Install Images API",
     long_description=long_description,
     long_description_content_type="text/markdown",
     license='BSD 2-clause',
     packages=['uiipythonapi'],
-    package_dir={'uiipythonapi': 'src/uiipythonapi'},
+    package_dir={'uiipythonapi': './uiipythonapi'},
     install_requires=[
         'requests'
     ],

src/__init__.py

@@ -1,5 +1,7 @@
+"""
+Python API package
+"""
+
 __version__ = "0.0.1"
 
 from .client import Client
-
-

src/uiipythonapi/__init__.py uiipythonapi/__init__.pysrc/uiipythonapi/__init__.py renamed to uiipythonapi/__init__.py

@@ -1,13 +1,20 @@
+"""
+Client implementation for the Virtomize UII API.
+"""
+# pylint: disable=too-many-arguments,broad-except
 import requests
 
-base_url = "https://api.virtomize.com/uii/"
+BASE_URL = "https://api.virtomize.com/uii/"
+
 
 class Client:
+    """ Client to interact with the Virtomize UII API. """
     def __init__(self, token):
         self.token = token
 
     def read_os_list(self):
-        endpoint = base_url + "oslist"
+        """ Read a list of all supported operating systems """
+        endpoint = BASE_URL + "oslist"
         headers = self.__default_header()
 
         response = requests.get(endpoint, headers=headers, verify=False)
@@ -21,7 +28,8 @@ def read_os_list(self):
         return [], "no data returned"
 
     def read_package_list(self, dist: str, version: str, arch: str):
-        endpoint = base_url + "packages"
+        """ Read a list of all available packages for an operating system """
+        endpoint = BASE_URL + "packages"
         headers = self.__default_header()
         data = {
             "arch": arch,
@@ -40,8 +48,15 @@ def read_package_list(self, dist: str, version: str, arch: str):
 
         return [], "no data returned"
 
-    def build(self, destination: str, dist: str, version: str, arch: str, hostname: str, networks) -> str:
-        endpoint = base_url + "images"
+    def build(self,
+              destination: str,
+              dist: str,
+              version: str,
+              arch: str,
+              hostname: str,
+              networks) -> str:
+        """ Build an ISO """
+        endpoint = BASE_URL + "images"
         headers = self.__default_header()
         data = {
             "arch": arch,
@@ -55,10 +70,10 @@ def build(self, destination: str, dist: str, version: str, arch: str, hostname:
         if not response.status_code == 200:
             return parse_error(response)
 
-        with open(destination, "wb") as f:
+        with open(destination, "wb") as iso_file:
             for chunk in response.iter_content(chunk_size=16 * 1024):
-                f.write(chunk)
-        return
+                iso_file.write(chunk)
+        return ""
 
     def __default_header(self):
         return {
@@ -67,12 +82,13 @@ def __default_header(self):
         }
 
 def parse_error(response) -> str:
+    """ Parse an error returned by the API """
     try:
         response_json = response.json()
         if "errors" in response_json:
             errors = response_json["errors"]
             return ", ".join(errors)
-    except:
-        pass
+    except Exception as ex:
+        print(f'Error calling API: {ex}')
 
-    return "request was not successful and returned \"" + str(response.content) + "\""
+    return "request was not successful and returned \"" + str(response.content) + "\""