Metadata-Version: 2.1
Name: uiipythonapi
Version: 1.0.0
Summary: A client implemenation for Virtomize Unattended Install Images API
Home-page: https://github.com/virtomize/uii-python-api
Author: Virtomize GmbH
Author-email: api@virtomize.com
License: BSD 2-clause
Description: # UII Python API
        This repository contains an implementation of a client for the [**Virtomize Unattended Install Images API**](https://uii.virtomize.com/).
        
        ## Build an ISO
        Building an ISO requires two steps.
        1. Create a client object by using the `NewClient` function. 
        This requires the API token created in the UI (see below). 
        
        ```python
        import uiipythonapi as uii
        api = uii.Client("token here")
        ```
        
        2. Building the ISO by using `build` on the client object. 
        ```python
        err = api.build("debian10.iso", "debian", "10", "x86_64", "hostnamehere", [{
                "dhcp": True,        
                "nointernet": False,
            }])
        ```
           
           `build` requires the following parameters: 
           - A path to the output file
           - The name of the distribution
           - The version number of the distribution
           - The architecture of the distirbution (`x86_64` in most cases)
           - A configuration of the network interfaces
              
        ## Register an API token
        Before using this client library, you need to register an API token under your account.
        For this, login into the [website](virtomize.com) and go to the "API-Token" tab.
        
        ![API-Token tab](https://github.com/Virtomize/uii_go_api/blob/60f79a50fc429f630eba553aaf057e6daa12ef97/doc/api-token.png "API-Token tab")
        
        There, create a new API token by clicking "Create" and give it a name. Then click save.
        ![Create a token](https://github.com/Virtomize/uii_go_api/blob/60f79a50fc429f630eba553aaf057e6daa12ef97/doc/api-token-create.png "Create a token")
        
        A new token will be created.
        Copy this token, as it will be hidden, once you log out.
        There, create a new API token by clicking "Create" and give it a name. Then click save.
        ![Save token](https://github.com/Virtomize/uii_go_api/blob/60f79a50fc429f630eba553aaf057e6daa12ef97/doc/api-token-created.png "Save token")
        
        
        
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
