flamapy-rest 2.0.0__tar.gz

flamapy-rest-2.0.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.1
+Name: flamapy-rest
+Version: 2.0.0
+Summary: Flamapy feature model is a distribution of the flama framework containing all plugins required to analyze feature models. It also offers a richier API and a complete command line interface and documentation.
+Home-page: https://github.com/flamapy/flamapy-feature-model
+Author: Flamapy
+Author-email: flamapy@us.es
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+
+<div align="center">
+
+  <a href="">[![Pytest Testing Suite](https://github.com/flamapy/flamapy-rest/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/flamapy/flamapy-rest/actions/workflows/tests.yml)</a>
+  <a href="">[![Commits Syntax Checker](https://github.com/flamapy/flamapy-rest/actions/workflows/commits.yml/badge.svg?branch=main)](https://github.com/flamapy/flamapy-rest/actions/workflows/commits.yml)</a>
+  <a href="">![PyPI](https://img.shields.io/pypi/v/flamapy-rest?label=pypi%20package)
+  <a href="">![PyPI - Downloads](https://img.shields.io/pypi/dm/flamapy-rest)
+</div>
+
+# 
+
+<div id="top"></div>
+<br />
+<div align="center">
+
+  <h3 align="center">FLAMAPY rest API</h3>
+
+  <p align="center">
+    A new and easy way to use FLAMA
+    <br />
+    <a href="https://github.com/flamapy/flamapy-fm-dist/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/flamapy/flamapy-fm-dist/issues">Request Feature</a>
+  </p>
+</div>
+<!-- ABOUT THE PROJECT -->
+
+## About The Project
+
+FLAMAPY Feature model distribution provides an easier way of using FLAMA when analysing feature models. It packs the most used plugins for analyis of feature models adding a layer of convenience to use the framework or integrate it. 
+
+Feature Model Analysis has a crucial role in software product line engineering, enabling us to understand, design, and validate the complex relationships among features in a software product line. These feature models can often be complex and challenging to analyze due to their variability, making it difficult to identify conflicts, dead features, and potential optimizations. This is where this distribution comes in.
+
+Please note: This is a living document and we will continue to update and improve it as we release new versions of the plugins and receive feedback from our users. If there's anything you don't understand or if you have any suggestions for improvement, don't hesitate to contact us. We're here to help!
+
+Three main interfaces are provided:
+* A REST API: The REST API allows for easy integration with other tools and applications. It is also a more user friendly interface for those who are not familiar with the command line.
+
+Whant it to runint, simply run
+```bash
+pip install flamapy-rest
+gunicorn --bind 0.0.0.0:8000 app:app
+```
+
+Alternatively, you can use docker in this way:
+```bash
+chmod +x start-server.sh
+./start-server.sh
+```
+Or go to [the render deployed version]() it isn't fast, but its free. 
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+### Built With
+
+* [Docker](https://www.docker.com/)
+* [Flask](https://flask.palletsprojects.com/en/2.2.x/)
+* [FLAMAPY](https://github.com/flamapy)
+* [Flasgger](https://github.com/flasgger/flasgger)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+# Using the distribution REST API
+The easies way is to execute the following command: docker run -p 8000:8000 flamapy/flamapy-fm-dist and open localhost:8000
+<!-- GETTING STARTED -->
+## Getting Started
+
+To get a local copy up and running follow these simple example steps.
+
+First, you will need to install [Docker](https://docs.docker.com/desktop/).
+
+### Instalation
+
+1. Clone the repository
+
+2. If you are running Windows, run
+  ```sh
+  $ cd flamapy-dm-dist
+  $ ./start-server.cmd
+  ```
+  
+3. If you are running Linux or MacOS, run
+  ```sh
+  $ cd flamapy-dm-dist
+  $ ./start-server.sh
+  ```
+  
+This script will build, install and deploy the API in http://localhost:8000, you can access all the endpoints through an application like [Postman](https://www.postman.com/)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+### API Documentation
+
+All the documentation is registered with Swagger UI and OAS 3.0. It is accesible through /api/v1/docs. This documentation is generated dinamically by relyin gon flasgger. DO not forget to document your code in the route files!
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+

flamapy-rest-2.0.0/README.md

@@ -0,0 +1,95 @@
+<div align="center">
+
+  <a href="">[![Pytest Testing Suite](https://github.com/flamapy/flamapy-rest/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/flamapy/flamapy-rest/actions/workflows/tests.yml)</a>
+  <a href="">[![Commits Syntax Checker](https://github.com/flamapy/flamapy-rest/actions/workflows/commits.yml/badge.svg?branch=main)](https://github.com/flamapy/flamapy-rest/actions/workflows/commits.yml)</a>
+  <a href="">![PyPI](https://img.shields.io/pypi/v/flamapy-rest?label=pypi%20package)
+  <a href="">![PyPI - Downloads](https://img.shields.io/pypi/dm/flamapy-rest)
+</div>
+
+# 
+
+<div id="top"></div>
+<br />
+<div align="center">
+
+  <h3 align="center">FLAMAPY rest API</h3>
+
+  <p align="center">
+    A new and easy way to use FLAMA
+    <br />
+    <a href="https://github.com/flamapy/flamapy-fm-dist/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/flamapy/flamapy-fm-dist/issues">Request Feature</a>
+  </p>
+</div>
+<!-- ABOUT THE PROJECT -->
+
+## About The Project
+
+FLAMAPY Feature model distribution provides an easier way of using FLAMA when analysing feature models. It packs the most used plugins for analyis of feature models adding a layer of convenience to use the framework or integrate it. 
+
+Feature Model Analysis has a crucial role in software product line engineering, enabling us to understand, design, and validate the complex relationships among features in a software product line. These feature models can often be complex and challenging to analyze due to their variability, making it difficult to identify conflicts, dead features, and potential optimizations. This is where this distribution comes in.
+
+Please note: This is a living document and we will continue to update and improve it as we release new versions of the plugins and receive feedback from our users. If there's anything you don't understand or if you have any suggestions for improvement, don't hesitate to contact us. We're here to help!
+
+Three main interfaces are provided:
+* A REST API: The REST API allows for easy integration with other tools and applications. It is also a more user friendly interface for those who are not familiar with the command line.
+
+Whant it to runint, simply run
+```bash
+pip install flamapy-rest
+gunicorn --bind 0.0.0.0:8000 app:app
+```
+
+Alternatively, you can use docker in this way:
+```bash
+chmod +x start-server.sh
+./start-server.sh
+```
+Or go to [the render deployed version]() it isn't fast, but its free. 
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+### Built With
+
+* [Docker](https://www.docker.com/)
+* [Flask](https://flask.palletsprojects.com/en/2.2.x/)
+* [FLAMAPY](https://github.com/flamapy)
+* [Flasgger](https://github.com/flasgger/flasgger)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+# Using the distribution REST API
+The easies way is to execute the following command: docker run -p 8000:8000 flamapy/flamapy-fm-dist and open localhost:8000
+<!-- GETTING STARTED -->
+## Getting Started
+
+To get a local copy up and running follow these simple example steps.
+
+First, you will need to install [Docker](https://docs.docker.com/desktop/).
+
+### Instalation
+
+1. Clone the repository
+
+2. If you are running Windows, run
+  ```sh
+  $ cd flamapy-dm-dist
+  $ ./start-server.cmd
+  ```
+  
+3. If you are running Linux or MacOS, run
+  ```sh
+  $ cd flamapy-dm-dist
+  $ ./start-server.sh
+  ```
+  
+This script will build, install and deploy the API in http://localhost:8000, you can access all the endpoints through an application like [Postman](https://www.postman.com/)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+### API Documentation
+
+All the documentation is registered with Swagger UI and OAS 3.0. It is accesible through /api/v1/docs. This documentation is generated dinamically by relyin gon flasgger. DO not forget to document your code in the route files!
+
+<p align="right">(<a href="#top">back to top</a>)</p>

flamapy-rest-2.0.0/flamapy/interfaces/rest/operations_routes.py

@@ -0,0 +1,116 @@
+import os
+import inspect
+import json
+
+from flask import Blueprint, request, jsonify
+from flamapy.interfaces.python.flamapy_feature_model import FLAMAFeatureModel
+from flamapy.metamodels.configuration_metamodel.models import Configuration
+
+
+operations_bp = Blueprint('operations_bp', __name__, url_prefix='/api/v1/operations')
+
+MODEL_FOLDER = './resources/models/'
+
+class CustomJSONEncoder(json.JSONEncoder):
+    def default(self, obj):
+        if isinstance(obj, Configuration):
+            return obj.__dict__ 
+        return super().default(obj)
+    
+def _api_call(operation_name: str):
+    # Get files
+    uploaded_model = request.files['model']
+    
+    # Check if file is provided
+    if uploaded_model.filename != '':
+        # Save file
+        uploaded_model.save(os.path.join(MODEL_FOLDER, uploaded_model.filename))
+        
+        fm = FLAMAFeatureModel(os.path.join(MODEL_FOLDER, uploaded_model.filename))
+        operation = getattr(fm, operation_name)
+        
+        # Extract the method signature
+        sig = inspect.signature(operation)
+        params = sig.parameters
+        
+        args = []
+        for param in params.values():
+            if param.name == 'feature_name':
+                args.append(request.form['feature'])
+            elif param.name == 'configuration_path':
+                configuration = request.files['configuration']
+                configuration.save(os.path.join(MODEL_FOLDER, configuration.filename))
+                args.append(os.path.join(MODEL_FOLDER, configuration.filename))
+        
+        result = operation(*args)
+
+        # Remove file
+        os.remove(os.path.join(MODEL_FOLDER, uploaded_model.filename))
+        
+        if 'configuration' in request.files:
+            os.remove(os.path.join(MODEL_FOLDER, request.files['configuration'].filename))
+        
+        # Return result
+        if result is None:
+            return jsonify(error='Not valid result'), 404
+        else:
+            return jsonify(json.loads(json.dumps(result, cls=CustomJSONEncoder)))
+
+
+def extract_docstring_with_swagger_info(method):
+    docstring = method.__doc__ or ""
+    parameters = """
+    parameters:
+      - name: model
+        in: formData
+        type: file
+        required: true
+    """
+    
+    # Extract the method signature
+    sig = inspect.signature(method)
+    for param in sig.parameters.values():
+        if param.name == 'feature_name':
+            parameters += """
+      - name: feature
+        in: formData
+        type: string
+        required: true
+    """
+        elif param.name == 'configuration_path':
+            parameters += """
+      - name: configuration
+        in: formData
+        type: file
+        required: true
+    """
+
+    swagger_info = """
+    ---
+    tags:
+      - {operation_name}
+    {parameters}
+    responses:
+      200:
+        description: Result of the operation
+        examples:
+          result: Example result
+    """.format(operation_name=method.__name__, parameters=parameters)
+        # Replace new lines with HTML line breaks
+    docstring = docstring.replace('\n', '')
+    return docstring + swagger_info
+
+def create_route(operation_name: str, docstring: str):
+    def route_function():
+        return _api_call(operation_name)
+    
+    route_function.__name__ = operation_name
+    route_function.__doc__ = docstring
+    return route_function
+
+# Introspect FLAMAFeatureModel class to find all callable methods and create routes dynamically
+for name, method in inspect.getmembers(FLAMAFeatureModel, predicate=inspect.isfunction):
+    if name.startswith('_'):
+        continue
+    docstring = extract_docstring_with_swagger_info(method)
+    operations_bp.route(f'/{name}', methods=['POST'])(create_route(name, docstring))

flamapy-rest-2.0.0/flamapy_rest.egg-info/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.1
+Name: flamapy-rest
+Version: 2.0.0
+Summary: Flamapy feature model is a distribution of the flama framework containing all plugins required to analyze feature models. It also offers a richier API and a complete command line interface and documentation.
+Home-page: https://github.com/flamapy/flamapy-feature-model
+Author: Flamapy
+Author-email: flamapy@us.es
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+
+<div align="center">
+
+  <a href="">[![Pytest Testing Suite](https://github.com/flamapy/flamapy-rest/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/flamapy/flamapy-rest/actions/workflows/tests.yml)</a>
+  <a href="">[![Commits Syntax Checker](https://github.com/flamapy/flamapy-rest/actions/workflows/commits.yml/badge.svg?branch=main)](https://github.com/flamapy/flamapy-rest/actions/workflows/commits.yml)</a>
+  <a href="">![PyPI](https://img.shields.io/pypi/v/flamapy-rest?label=pypi%20package)
+  <a href="">![PyPI - Downloads](https://img.shields.io/pypi/dm/flamapy-rest)
+</div>
+
+# 
+
+<div id="top"></div>
+<br />
+<div align="center">
+
+  <h3 align="center">FLAMAPY rest API</h3>
+
+  <p align="center">
+    A new and easy way to use FLAMA
+    <br />
+    <a href="https://github.com/flamapy/flamapy-fm-dist/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/flamapy/flamapy-fm-dist/issues">Request Feature</a>
+  </p>
+</div>
+<!-- ABOUT THE PROJECT -->
+
+## About The Project
+
+FLAMAPY Feature model distribution provides an easier way of using FLAMA when analysing feature models. It packs the most used plugins for analyis of feature models adding a layer of convenience to use the framework or integrate it. 
+
+Feature Model Analysis has a crucial role in software product line engineering, enabling us to understand, design, and validate the complex relationships among features in a software product line. These feature models can often be complex and challenging to analyze due to their variability, making it difficult to identify conflicts, dead features, and potential optimizations. This is where this distribution comes in.
+
+Please note: This is a living document and we will continue to update and improve it as we release new versions of the plugins and receive feedback from our users. If there's anything you don't understand or if you have any suggestions for improvement, don't hesitate to contact us. We're here to help!
+
+Three main interfaces are provided:
+* A REST API: The REST API allows for easy integration with other tools and applications. It is also a more user friendly interface for those who are not familiar with the command line.
+
+Whant it to runint, simply run
+```bash
+pip install flamapy-rest
+gunicorn --bind 0.0.0.0:8000 app:app
+```
+
+Alternatively, you can use docker in this way:
+```bash
+chmod +x start-server.sh
+./start-server.sh
+```
+Or go to [the render deployed version]() it isn't fast, but its free. 
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+### Built With
+
+* [Docker](https://www.docker.com/)
+* [Flask](https://flask.palletsprojects.com/en/2.2.x/)
+* [FLAMAPY](https://github.com/flamapy)
+* [Flasgger](https://github.com/flasgger/flasgger)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+# Using the distribution REST API
+The easies way is to execute the following command: docker run -p 8000:8000 flamapy/flamapy-fm-dist and open localhost:8000
+<!-- GETTING STARTED -->
+## Getting Started
+
+To get a local copy up and running follow these simple example steps.
+
+First, you will need to install [Docker](https://docs.docker.com/desktop/).
+
+### Instalation
+
+1. Clone the repository
+
+2. If you are running Windows, run
+  ```sh
+  $ cd flamapy-dm-dist
+  $ ./start-server.cmd
+  ```
+  
+3. If you are running Linux or MacOS, run
+  ```sh
+  $ cd flamapy-dm-dist
+  $ ./start-server.sh
+  ```
+  
+This script will build, install and deploy the API in http://localhost:8000, you can access all the endpoints through an application like [Postman](https://www.postman.com/)
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+### API Documentation
+
+All the documentation is registered with Swagger UI and OAS 3.0. It is accesible through /api/v1/docs. This documentation is generated dinamically by relyin gon flasgger. DO not forget to document your code in the route files!
+
+<p align="right">(<a href="#top">back to top</a>)</p>
+
+

flamapy-rest-2.0.0/flamapy_rest.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+setup.py
+flamapy/interfaces/rest/operations_routes.py
+flamapy_rest.egg-info/PKG-INFO
+flamapy_rest.egg-info/SOURCES.txt
+flamapy_rest.egg-info/dependency_links.txt
+flamapy_rest.egg-info/requires.txt
+flamapy_rest.egg-info/top_level.txt

flamapy-rest-2.0.0/flamapy_rest.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

flamapy-rest-2.0.0/flamapy_rest.egg-info/requires.txt

@@ -0,0 +1,16 @@
+wheel
+Flask
+gunicorn
+flamapy==2.0.0
+flask-swagger-ui
+flask-restplus
+pytest
+flask_cors
+flasgger
+
+[dev]
+pytest
+pytest-mock
+prospector
+mypy
+coverage

flamapy-rest-2.0.0/flamapy_rest.egg-info/top_level.txt

@@ -0,0 +1 @@
+flamapy

flamapy-rest-2.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flamapy-rest-2.0.0/setup.py

@@ -0,0 +1,37 @@
+import setuptools
+
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+def read_requirements(file):
+    with open(file, "r") as fh:
+        return fh.read().splitlines()
+
+# Read requirements from the requirements.txt file
+requirements = read_requirements("requirements.txt")
+
+# Read development requirements from the dev-requirements.txt file
+dev_requirements = read_requirements("requirements-dev.txt")
+
+setuptools.setup(
+    name="flamapy-rest",
+    version="2.0.0",
+    author="Flamapy",
+    author_email="flamapy@us.es",
+    description="Flamapy feature model is a distribution of the flama framework containing all plugins required to analyze feature models. It also offers a richier API and a complete command line interface and documentation.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/flamapy/flamapy-feature-model",
+    packages=setuptools.find_namespace_packages(include=['flamapy.*']),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.9',
+    install_requires=requirements,
+    extras_require={
+        'dev': dev_requirements
+    }
+)