Py4HEAppE 1.0.0__tar.gz → 2.0.0__tar.gz

py4heappe-2.0.0/.gitlab/stages/.generation.yml

@@ -0,0 +1,25 @@
+## GENERATION STAGE
+
+API_client_generation:
+  stage: API_generation
+  image: openjdk:11-jre-slim
+  when: manual
+  rules:
+    - if: '$CI_COMMIT_BRANCH != "develop" && $CI_COMMIT_BRANCH != "main"'
+  before_script:
+    - apt-get update 
+    - apt-get install -y wget zip
+    - wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.27/swagger-codegen-cli-2.4.27.jar -O /swagger-codegen-cli.jar
+  script:
+    - echo "Generation API client"
+    - java -jar /swagger-codegen-cli.jar generate -i Tools/APIWrapperGen/swagger.json -l python -t Tools/APIWrapperGen/Templates/python/ -o ./app/client -c Tools/APIWrapperGen/config.json
+    - cd app/client/py4heappe
+    - zip -r ../../../APIWrapperGen.zip .
+  tags:
+    - Docker
+    - Centos9
+    - IT4I_Network
+  artifacts:
+    paths:
+      - APIWrapperGen.zip
+    expire_in: 1 days

{py4heappe-1.0.0 → py4heappe-2.0.0}/.gitlab-ci.yml

@@ -2,6 +2,7 @@ services:
   - docker:dind
 
 include:
+  - local: '.gitlab/stages/.generation.yml'
   - local: '.gitlab/stages/.check.yml'
   - local: '.gitlab/stages/.release.yml'
   - local: '.gitlab/stages/.publish.yml'
@@ -9,6 +10,7 @@ include:
 
 
 stages:
+  - API_generation
   - check
   - release
   - publish

{py4heappe-1.0.0 → py4heappe-2.0.0}/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## V2.0.0
+
+### Compatible with HEAppE V5.X.X
+
+
 ## V1.0.0
 
-###  Compatible with HEAppE V4.2.X and V4.3.X
+### Compatible with HEAppE V4.2.X and V4.3.X

{py4heappe-1.0.0/src/Py4HEAppE.egg-info → py4heappe-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Py4HEAppE
-Version: 1.0.0
+Version: 2.0.0
 Summary: Py4HEAppE is client library for easy access to HEAppE Middleware
 Author-email: IT4Innovations <support.heappe@it4i.cz>
 License-Expression: MIT
@@ -57,7 +57,7 @@ The library ensures consistent and reliable communication with the HEAppE API, h
 ### Installation
 
 ```
-pip install py4heappe
+pip install Py4HEAppE
  ```
 
 <b>Note:</b> In some cases, you can obtain a warning message like this <b>"WARNING: The script py4heappe.exe is installed in 'C:\Users\user\AppData\Roaming\Python\Python311\Scripts' which is not on PATH.</b>" If you obtained a similar warning message, it is necessary to add the mentioned path into your operation system <b>PATH</b> variable or use a path with an executable file (i.e. C:\Users\user\AppData\Roaming\Python\Python311\Scripts\py4heappe.exe).

{py4heappe-1.0.0 → py4heappe-2.0.0}/README.md

@@ -32,7 +32,7 @@ The library ensures consistent and reliable communication with the HEAppE API, h
 ### Installation
 
 ```
-pip install py4heappe
+pip install Py4HEAppE
  ```
 
 <b>Note:</b> In some cases, you can obtain a warning message like this <b>"WARNING: The script py4heappe.exe is installed in 'C:\Users\user\AppData\Roaming\Python\Python311\Scripts' which is not on PATH.</b>" If you obtained a similar warning message, it is necessary to add the mentioned path into your operation system <b>PATH</b> variable or use a path with an executable file (i.e. C:\Users\user\AppData\Roaming\Python\Python311\Scripts\py4heappe.exe).

py4heappe-2.0.0/Tools/APIWrapperGen/README.md

@@ -0,0 +1,10 @@
+# Py4HEAppE API Client Generation
+The content contains how to re-generate the HEAppE API wrapper with the new version of the HEAppE API
+
+## Steps
+1. Obtain HEAppE API Swagger definition **(eg.http://localhost:5000/swagger/py4heappe/swagger.json)**
+2. Upload the downloaded Swagger definition and replace it in repository folder **'Tools\APIWrapperGen\swagger.json'** 
+3. Commit into random branch (not into develop or main)
+4. Manually triggered pipeline for the API wrapper generation
+5. Download pipeline artefact and replace files in **'src/py4heappe/core' (except base directory)**
+6. Modify Py4HEAppE CLI affected commands

py4heappe-2.0.0/Tools/APIWrapperGen/Templates/python/README.mustache

@@ -0,0 +1,129 @@
+# {{{projectName}}}
+{{#appDescription}}
+{{{appDescription}}}
+{{/appDescription}}
+
+This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: {{appVersion}}
+- Package version: {{packageVersion}}
+{{^hideGenerationTimestamp}}
+- Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+- Build package: {{generatorClass}}
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
+## Requirements.
+
+Python 2.7 and 3.4+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on Github, you can install directly from Github
+
+```sh
+pip install git+https://github.com/{{{gitUserId}}}/{{{gitRepoId}}}.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/{{{gitUserId}}}/{{{gitRepoId}}}.git`)
+
+Then import the package:
+```python
+import {{{packageName}}} 
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import {{{packageName}}}
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+from __future__ import print_function
+import time
+import {{{packageName}}}
+from {{{packageName}}}.rest import ApiException
+from pprint import pprint
+{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}{{#authMethods}}{{#isBasic}}
+# Configure HTTP basic authorization: {{{name}}}
+configuration = {{{packageName}}}.Configuration()
+configuration.username = 'YOUR_USERNAME'
+configuration.password = 'YOUR_PASSWORD'{{/isBasic}}{{#isApiKey}}
+# Configure API key authorization: {{{name}}}
+configuration = {{{packageName}}}.Configuration()
+configuration.api_key['{{{keyParamName}}}'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
+# Configure OAuth2 access token for authorization: {{{name}}}
+configuration = {{{packageName}}}.Configuration()
+configuration.access_token = 'YOUR_ACCESS_TOKEN'{{/isOAuth}}{{/authMethods}}
+{{/hasAuthMethods}}
+
+# create an instance of the API class
+api_instance = {{{packageName}}}.{{{classname}}}({{{packageName}}}.ApiClient(configuration))
+{{#allParams}}{{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
+{{/allParams}}
+
+try:
+{{#summary}}    # {{{.}}}
+{{/summary}}    {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#allParams}}{{#required}}{{paramName}}{{/required}}{{^required}}{{paramName}}={{paramName}}{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}){{#returnType}}
+    pprint(api_response){{/returnType}}
+except ApiException as e:
+    print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e)
+{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *{{basePath}}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+
+## Documentation For Models
+
+{{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}{{{classname}}}.md)
+{{/model}}{{/models}}
+
+## Documentation For Authorization
+
+{{^authMethods}} All endpoints do not require authorization.
+{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}}
+{{#authMethods}}## {{{name}}}
+
+{{#isApiKey}}- **Type**: API key
+- **API key parameter name**: {{{keyParamName}}}
+- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
+{{/isApiKey}}
+{{#isBasic}}- **Type**: HTTP basic authentication
+{{/isBasic}}
+{{#isOAuth}}- **Type**: OAuth
+- **Flow**: {{{flow}}}
+- **Authorization URL**: {{{authorizationUrl}}}
+- **Scopes**: {{^scopes}}N/A{{/scopes}}
+{{#scopes}} - **{{{scope}}}**: {{{description}}}
+{{/scopes}}
+{{/isOAuth}}
+
+{{/authMethods}}
+
+## Author
+
+{{#apiInfo}}{{#apis}}{{^hasMore}}{{infoEmail}}
+{{/hasMore}}{{/apis}}{{/apiInfo}}

py4heappe-2.0.0/Tools/APIWrapperGen/Templates/python/__init__api.mustache

@@ -0,0 +1,7 @@
+from __future__ import absolute_import
+
+# flake8: noqa
+
+# import apis into api package
+{{#apiInfo}}{{#apis}}from {{apiPackage}}.{{classVarName}} import {{classname}}
+{{/apis}}{{/apiInfo}}

py4heappe-2.0.0/Tools/APIWrapperGen/Templates/python/__init__model.mustache

@@ -0,0 +1,10 @@
+# coding: utf-8
+
+# flake8: noqa
+{{>partial_header}}
+
+from __future__ import absolute_import
+
+# import models into model package
+{{#models}}{{#model}}from {{modelPackage}}.{{classFilename}} import {{classname}}{{/model}}
+{{/models}}

py4heappe-2.0.0/Tools/APIWrapperGen/Templates/python/__init__package.mustache

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+# flake8: noqa
+
+{{>partial_header}}
+
+from __future__ import absolute_import
+
+# import apis into sdk package
+{{#apiInfo}}{{#apis}}from {{apiPackage}}.{{classVarName}} import {{classname}}
+{{/apis}}{{/apiInfo}}
+# import ApiClient
+from {{packageName}}.api_client import ApiClient
+from {{packageName}}.configuration import Configuration
+# import models into sdk package
+{{#models}}{{#model}}from {{modelPackage}}.{{classFilename}} import {{classname}}
+{{/model}}{{/models}}

py4heappe-2.0.0/Tools/APIWrapperGen/Templates/python/__init__test.mustache

@@ -0,0 +1 @@
+# coding: utf-8

py4heappe-2.0.0/Tools/APIWrapperGen/Templates/python/api.mustache

@@ -0,0 +1,214 @@
+# coding: utf-8
+
+{{>partial_header}}
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from {{packageName}}.api_client import ApiClient
+
+
+{{#operations}}
+class {{classname}}(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    Ref: https://github.com/swagger-api/swagger-codegen
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+{{#operation}}
+
+    def {{operationId}}(self, {{#sortParamsByRequiredFlag}}{{#allParams}}{{#required}}{{baseName}}, {{/required}}{{/allParams}}{{/sortParamsByRequiredFlag}}**kwargs):  # noqa: E501
+        """{{#summary}}{{{.}}}{{/summary}}{{^summary}}{{operationId}}{{/summary}}  # noqa: E501
+
+{{#notes}}
+        {{{notes}}}  # noqa: E501
+{{/notes}}
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+{{#sortParamsByRequiredFlag}}
+        >>> thread = api.{{operationId}}({{#allParams}}{{#required}}{{baseName}}, {{/required}}{{/allParams}}async_req=True)
+{{/sortParamsByRequiredFlag}}
+{{^sortParamsByRequiredFlag}}
+        >>> thread = api.{{operationId}}({{#allParams}}{{#required}}{{baseName}}={{baseName}}_value, {{/required}}{{/allParams}}async_req=True)
+{{/sortParamsByRequiredFlag}}
+        >>> result = thread.get()
+
+        :param async_req bool
+{{#allParams}}
+        :param {{dataType}} {{baseName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}}
+{{/allParams}}
+        :return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}}
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.{{operationId}}_with_http_info({{#sortParamsByRequiredFlag}}{{#allParams}}{{#required}}{{baseName}}, {{/required}}{{/allParams}}{{/sortParamsByRequiredFlag}}**kwargs)  # noqa: E501
+        else:
+            (data) = self.{{operationId}}_with_http_info({{#sortParamsByRequiredFlag}}{{#allParams}}{{#required}}{{baseName}}, {{/required}}{{/allParams}}{{/sortParamsByRequiredFlag}}**kwargs)  # noqa: E501
+            return data
+
+    def {{operationId}}_with_http_info(self, {{#sortParamsByRequiredFlag}}{{#allParams}}{{#required}}{{baseName}}, {{/required}}{{/allParams}}{{/sortParamsByRequiredFlag}}**kwargs):  # noqa: E501
+        """{{#summary}}{{{.}}}{{/summary}}{{^summary}}{{operationId}}{{/summary}}  # noqa: E501
+
+{{#notes}}
+        {{{notes}}}  # noqa: E501
+{{/notes}}
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+{{#sortParamsByRequiredFlag}}
+        >>> thread = api.{{operationId}}_with_http_info({{#allParams}}{{#required}}{{baseName}}, {{/required}}{{/allParams}}async_req=True)
+{{/sortParamsByRequiredFlag}}
+{{^sortParamsByRequiredFlag}}
+        >>> thread = api.{{operationId}}_with_http_info({{#allParams}}{{#required}}{{baseName}}={{baseName}}_value, {{/required}}{{/allParams}}async_req=True)
+{{/sortParamsByRequiredFlag}}
+        >>> result = thread.get()
+
+        :param async_req bool
+{{#allParams}}
+        :param {{dataType}} {{baseName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/optional}}
+{{/allParams}}
+        :return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}}
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = [{{#allParams}}'{{baseName}}'{{#hasMore}}, {{/hasMore}}{{/allParams}}]  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method {{operationId}}" % key
+                )
+            params[key] = val
+        del params['kwargs']
+{{#allParams}}
+{{#required}}
+        # verify the required parameter '{{baseName}}' is set
+        if self.api_client.client_side_validation and ('{{baseName}}' not in params or
+                                                       params['{{baseName}}'] is None):  # noqa: E501
+            raise ValueError("Missing the required parameter `{{baseName}}` when calling `{{operationId}}`")  # noqa: E501
+{{/required}}
+{{/allParams}}
+
+{{#allParams}}
+{{#hasValidation}}
+    {{#maxLength}}
+        if self.api_client.client_side_validation and ('{{baseName}}' in params and
+                                                       len(params['{{baseName}}']) > {{maxLength}}):
+            raise ValueError("Invalid value for parameter `{{baseName}}` when calling `{{operationId}}`, length must be less than or equal to `{{maxLength}}`")  # noqa: E501
+    {{/maxLength}}
+    {{#minLength}}
+        if self.api_client.client_side_validation and ('{{baseName}}' in params and
+                                                       len(params['{{baseName}}']) < {{minLength}}):
+            raise ValueError("Invalid value for parameter `{{baseName}}` when calling `{{operationId}}`, length must be greater than or equal to `{{minLength}}`")  # noqa: E501
+    {{/minLength}}
+    {{#maximum}}
+        if self.api_client.client_side_validation and ('{{baseName}}' in params and params['{{baseName}}'] >{{#exclusiveMaximum}}={{/exclusiveMaximum}} {{maximum}}):  # noqa: E501
+            raise ValueError("Invalid value for parameter `{{baseName}}` when calling `{{operationId}}`, must be a value less than {{^exclusiveMaximum}}or equal to {{/exclusiveMaximum}}`{{maximum}}`")  # noqa: E501
+    {{/maximum}}
+    {{#minimum}}
+        if self.api_client.client_side_validation and ('{{baseName}}' in params and params['{{baseName}}'] <{{#exclusiveMinimum}}={{/exclusiveMinimum}} {{minimum}}):  # noqa: E501
+            raise ValueError("Invalid value for parameter `{{baseName}}` when calling `{{operationId}}`, must be a value greater than {{^exclusiveMinimum}}or equal to {{/exclusiveMinimum}}`{{minimum}}`")  # noqa: E501
+    {{/minimum}}
+    {{#pattern}}
+        if self.api_client.client_side_validation and ('{{baseName}}' in params and not re.search(r'{{{vendorExtensions.x-regex}}}', params['{{baseName}}']{{#vendorExtensions.x-modifiers}}{{#-first}}, flags={{/-first}}re.{{.}}{{^-last}} | {{/-last}}{{/vendorExtensions.x-modifiers}})):  # noqa: E501
+            raise ValueError("Invalid value for parameter `{{baseName}}` when calling `{{operationId}}`, must conform to the pattern `{{{pattern}}}`")  # noqa: E501
+    {{/pattern}}
+    {{#maxItems}}
+        if self.api_client.client_side_validation and ('{{baseName}}' in params and
+                                            len(params['{{baseName}}']) > {{maxItems}}):
+            raise ValueError("Invalid value for parameter `{{baseName}}` when calling `{{operationId}}`, number of items must be less than or equal to `{{maxItems}}`")  # noqa: E501
+    {{/maxItems}}
+    {{#minItems}}
+        if self.api_client.client_side_validation and ('{{baseName}}' in params and
+                                            len(params['{{baseName}}']) < {{minItems}}):
+            raise ValueError("Invalid value for parameter `{{baseName}}` when calling `{{operationId}}`, number of items must be greater than or equal to `{{minItems}}`")  # noqa: E501
+    {{/minItems}}
+{{/hasValidation}}
+{{#-last}}
+{{/-last}}
+{{/allParams}}
+        collection_formats = {}
+
+        path_params = {}
+{{#pathParams}}
+        if '{{baseName}}' in params:
+            path_params['{{baseName}}'] = params['{{baseName}}']{{#isListContainer}}  # noqa: E501
+            collection_formats['{{baseName}}'] = '{{collectionFormat}}'{{/isListContainer}}  # noqa: E501
+{{/pathParams}}
+
+        query_params = []
+{{#queryParams}}
+        if '{{baseName}}' in params:
+            query_params.append(('{{baseName}}', params['{{baseName}}'])){{#isListContainer}}  # noqa: E501
+            collection_formats['{{baseName}}'] = '{{collectionFormat}}'{{/isListContainer}}  # noqa: E501
+{{/queryParams}}
+
+        header_params = {}
+{{#headerParams}}
+        if '{{baseName}}' in params:
+            header_params['{{baseName}}'] = params['{{baseName}}']{{#isListContainer}}  # noqa: E501
+            collection_formats['{{baseName}}'] = '{{collectionFormat}}'{{/isListContainer}}  # noqa: E501
+{{/headerParams}}
+
+        form_params = []
+        local_var_files = {}
+{{#formParams}}
+        if '{{baseName}}' in params:
+            {{#notFile}}form_params.append(('{{baseName}}', params['{{baseName}}'])){{/notFile}}{{#isFile}}local_var_files['{{baseName}}'] = params['{{baseName}}']{{/isFile}}{{#isListContainer}}  # noqa: E501
+            collection_formats['{{baseName}}'] = '{{collectionFormat}}'{{/isListContainer}}  # noqa: E501
+{{/formParams}}
+
+        body_params = None
+{{#bodyParam}}
+        if '{{baseName}}' in params:
+            body_params = params['{{baseName}}']
+{{/bodyParam}}
+        {{#hasProduces}}
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            [{{#produces}}'{{{mediaType}}}'{{#hasMore}}, {{/hasMore}}{{/produces}}])  # noqa: E501
+
+        {{/hasProduces}}
+        {{#hasConsumes}}
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            [{{#consumes}}'{{{mediaType}}}'{{#hasMore}}, {{/hasMore}}{{/consumes}}])  # noqa: E501
+
+        {{/hasConsumes}}
+        # Authentication setting
+        auth_settings = [{{#authMethods}}'{{name}}'{{#hasMore}}, {{/hasMore}}{{/authMethods}}]  # noqa: E501
+
+        return self.api_client.call_api(
+            '{{{path}}}', '{{httpMethod}}',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type={{#returnType}}'{{returnType}}'{{/returnType}}{{^returnType}}None{{/returnType}},  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+{{/operation}}
+{{/operations}}